Skip to contents

Returns a minimal pagination info data.frame (with no sibling/footnote/etc info).

Usage

basic_pagdf(
  rnames,
  labs = rnames,
  rnums = seq_along(rnames),
  extents = 1L,
  rclass = "NA",
  parent_path = "root"
)

Arguments

rnames

character. Vector of row names

labs

character. Vector of row labels (defaults to names)

rnums

integer. Vector of row numbers. Defaults to seq_along(rnames).

extents

integer. Number of lines each row will take to print, defaults to 1 for all rows

rclass

character. Class(es) for the rows. Defaults to "NA"

parent_path

character. parent path that all rows should be "children of", defaults to "root", and generally should not matter to end users.

Value

A data.frame suitable for use in both the matrix_print_form constructor and the pagination machinery

Examples


basic_pagdf(c("hi", "there"))
#>       label  name abs_rownumber        path pos_in_siblings n_siblings
#> hi       hi    hi             1    root, hi               1          2
#> there there there             2 root, there               2          2
#>       self_extent par_extent reprint_inds node_class indent nrowrefs ncellrefs
#> hi              1          0                      NA      0        0         0
#> there           1          0                      NA      0        0         0
#>       nreflines force_page page_title trailing_sep
#> hi            0      FALSE       <NA>         <NA>
#> there         0      FALSE       <NA>         <NA>