Usage
new_report(report = "report", template = getOption("temp_reports"), bib.loc = getOption("bib.loc"),
name = getOption("name_reports"), github.user = getOption("github.user"), sources = getOption("sources_reports"),
path = getwd(), AN.xlsx = TRUE)
Arguments
- report
- A character vector of length two or one:
(1) the main directory name and (2) sub directory names
(i.e., all the file contents will be imprinted with this
name). If the length of
report is one this name
will be used as the main directory name and all sub
directories and files.
- template
- A character string of the internal
reports template or an external path to a template in the
reports package style. This argument allows the user to
change the contents of the report directory that is
generated.
- bib.loc
- Optional path to a .bib resource.
- path
- The path to where the project should be
created. Default is the current working directory.
- name
- A character string of the user's name to be
used on the report.
- github.user
- GitHub user name (character string).
- sources
- A vector of path(s) to other scripts to be
sourced in the report project upon startup (adds this
location to the report project's
.Rprofile).
- AN.xlsx
- logical. If
TRUE the article notes
(AN) will be in .xlsx format. If FALSE the
document will be a .csv file.
Value
Creates a report template.
Description
Generate a report/paper template to increase efficiency.
Suggestion
The user may want to set options for
bib.loc, name_reports, temp_reports,
github.user and sources_reports in the
user's primary .Rprofile:
- bib.loc - The path to the users primary
bibliography
- name_reports - The name to use
on reports
- temp_reports - The primary
template to use to generate reports (see
template)
- github.user - GitHub user
name
- sources_reports - Path(s) to
additional files/scripts that should be included to be
sourced in the project startup
Examples
## Not run: # new_report()# ## End(Not run)