Page Plan — page_plan • tfrmt

Defining the location and/or frequency of page splits with a series of page_structure's and the row_every_n argument, respectively.

Usage

page_plan(
  ...,
  note_loc = c("noprint", "preheader", "subtitle", "source_note"),
  max_rows = NULL,
  transform = NULL
)

Arguments

...

a series of page_structure() separated by commas

note_loc

Location of the note describing each table's subset value(s). Useful if the page_structure contains only ".default" values (meaning the table is split by every unique level of a grouping variable), and that variable is dropped in the col_plan. preheader only available for rtf output.

max_rows

Option to set a maximum number of rows per page. Takes a numeric value.

transform

optional, a function or formula to transform the page label.

It should take a character vector as input and return a modified character vector as output.

A function is used as is, e.g. function(x) {stringr::str_replace(x, "grp", "Group")}

A formula, e.g. ~ stringr::str_remove_all(.x, "_") is converted to a function. This allows you to create more compact anonymous functions (lambdas).

Value

page_plan object

Examples

 # use of page_struct
 page_plan(
   page_structure(
     group_val = "grp1",
     label_val = "lbl1"
   )
 )
#> $struct_list
#> $struct_list[[1]]
#> $group_val
#> [1] "grp1"
#> 
#> $label_val
#> [1] "lbl1"
#> 
#> attr(,"class")
#> [1] "page_structure" "structure"     
#> 
#> 
#> $note_loc
#> [1] "noprint"
#> 
#> $max_rows
#> NULL
#> 
#> $transform
#> NULL
#> 
#> attr(,"class")
#> [1] "page_plan" "plan"     

 # use of #  rows
 page_plan(
   max_rows = 5
 )
#> $struct_list
#> list()
#> 
#> $note_loc
#> [1] "noprint"
#> 
#> $max_rows
#> [1] 5
#> 
#> $transform
#> NULL
#> 
#> attr(,"class")
#> [1] "page_plan" "plan"     

 # use of transform with a formula
 page_plan(
   page_structure(group_val = ".default"),
   transform = ~ stringr::str_replace(.x, "grp", "Group")
 )
#> $struct_list
#> $struct_list[[1]]
#> $group_val
#> [1] ".default"
#> 
#> $label_val
#> NULL
#> 
#> attr(,"class")
#> [1] "page_structure" "structure"     
#> 
#> 
#> $note_loc
#> [1] "noprint"
#> 
#> $max_rows
#> NULL
#> 
#> $transform
#> ~stringr::str_replace(.x, "grp", "Group")
#> <environment: 0x55a09dae6848>
#> 
#> attr(,"class")
#> [1] "page_plan" "plan"     

 # use of transform with a function
 transformation_function <- function(x) {
   stringr::str_replace(x, "grp", "Group")
 }

 page_plan(
   page_structure(group_val = ".default"),
   transform = transformation_function
 )
#> $struct_list
#> $struct_list[[1]]
#> $group_val
#> [1] ".default"
#> 
#> $label_val
#> NULL
#> 
#> attr(,"class")
#> [1] "page_structure" "structure"     
#> 
#> 
#> $note_loc
#> [1] "noprint"
#> 
#> $max_rows
#> NULL
#> 
#> $transform
#> function (x) 
#> {
#>     stringr::str_replace(x, "grp", "Group")
#> }
#> <environment: 0x55a09dae6848>
#> 
#> attr(,"class")
#> [1] "page_plan" "plan"