Skip to contents

Get text for the R file documenting a table

Usage

document_table(table_name)

Arguments

table_name

Valid table name existing in tables

Value

Character vector for the r file creating the roxygen dataset documentation

Examples

document_table(table_name = tables[[1, "tablename"]])
#> [1] "#' @format NULL"                            
#> [2] "#' @templateVar df_table_name df_21311LJ001"
#> [3] "#' @template dataset_documentation"         
#> [4] "'df_21311LJ001'"