knit_data_readme: Knit Codebooks to Single README

Description Usage Arguments Details Value See Also Examples

Description

Combine all other generated codebooks into a single README file for a data repository

Usage

1
2
knit_data_readme(input_dir = "auto", filename = "README",
  output_dir = "auto")

Arguments

input_dir

File directory of the existing codebooks, Default: "auto", assumes puddingR file directory and uses the "intermediate" folder inside "open_data"

filename

Name of output file, Default: 'README'

output_dir

File directory for final README, Default: "auto", assumes puddingR file directory, outputs to the "open_data" directory

Details

DETAILS

Value

OUTPUT_DESCRIPTION

See Also

render

Examples

1
2
3
4
5
6
7
8
## Not run: 
# using puddingR file structure
knit_data_readme()

# using other file structure
knit_data_readme(directory = "my_codebooks", output_dir = "public_data")

## End(Not run)

the-pudding/puddingR documentation built on June 25, 2019, 12:15 a.m.