Description Usage Arguments Details Value Examples
This function can be used to create a new report factory. By default, the factory is created with a template of report, and the working environment is moved to the newly created factory.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
factory |
The name of the report factory to be created. |
path |
The folder where the report factory should be created. This will default to the current directory. |
report_sources |
The name of the folder to be used for report templates; defaults to 'report_sources/'. |
outputs |
The name of the folder to be used for saving the built reports; defaults to 'outputs/'. |
move_in |
A |
create_README |
A |
create_example_report |
A |
create_data_folders |
a |
create_scripts_folder |
a |
use_here |
a |
use_rproj |
a |
create_gitignore |
a |
Assuming the default names are used then new_factory
will create a report
factory folder (called "new_factory") that includes:
report_sources
: a folder for storing the .Rmd reports
outputs
: a folder storing the compiled reports
factory_config
: a control file used to anchor a report factory
Depending on the values of the logical arguments, the factory may also include:
README.md
: Example README with instructions on how to use report factory.
.gitignore
: a file used to tell git to ignore certain files including the
produced outputs in outputs()
.
data/raw/
: a folder for storing raw data
data/raw/example_data.csv
: a set of data for use with the example report
data/clean/
: a folder for storing cleaned data
scripts/
: a folder to store additional code that may be called in reports
report_sources/example_report.Rmd
: an example .Rmd report template
.here
: a file to anchor calls to here::here()
the report factory folder location (invisibly)
1 2 | f1 <- new_factory("new_factory_1", move_in = FALSE)
f2 <- new_factory("new_factory_2", move_in = TRUE)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.