new_report: Report Template

In trinker/reports: An R Package to Assist in the Workflow of Writing Academic Articles and Other Reports

Description

Generate a report/paper template to increase efficiency.

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,
  present = getOption("present.template"), open = is.global(2),
  github = FALSE, ...)

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. See templates for more.
bib.loc	Optional path to a .bib resource.
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).
path	The path to where the project should be created. Default is the current working directory.
AN.xlsx	logical. If TRUE the article notes (AN) and websites documents will be in .xlsx format. If FALSE the document will be a .csv file.
present	The template to be used in the PRESENTATION .Rmd/.Rpres. This can be one of the types from slidify_templates , "rstudio" (this generates a .Rpres file), or a path to an .Rmd/.Rpres file. This argument will be overrode if a custom reports template is supplied with an .Rmd file in the inst directory named slidify.Rmd (‘~inst/slidify.Rmd’). Or an .Rpres file in the inst directory named rstudio.Rpres (‘~inst/slidify.Rmd’).
open	logical. If TRUE the project will be opened in RStudio. The default is to test if new_report is being used in the global environment, if it is then the project directory will be opened.
github	logical. If TRUE the repo will be sent to public GitHub account.
...	Other arguments passed to author.

Value

Creates a report template.

Suggestion

The user may want to set options for bib.loc, github.user, name.reports sources.reports,present.template and revealjs.loc in the user's primary .Rprofile:

1. bib.loc - The path to the users primary bibliography

2. name.reports - The name to use on reports

3. temp.reports - The primary template to use to generate reports (see template)

4. github.user - GitHub user name

5. speed.temp - A speed dial like interface that allows the template argument to take a numeric arguement. Setting this option takes the form of:
   options(speed.temp=list(`1`="wordpress_rmd", `2`="basic_rmd"))

6. sources.reports - Path(s) to additional files/scripts that should be included to be sourced in the project startup

7. present.template - Path to, or defualt, .Rmd/.Rpres file template for use in as the .Rmd/.Rpres used in the PRESENTATION directory (see slidify_templates for possible non-path arguments)

Additional Guide

Introductory video http://www.youtube.com/watch?v=ArHQjQyIS70

References

slidify examples
RStudio presentations

See Also

doc_temp, presentation, templates, slidify_templates, author

Installation section of reveal.js GitHub

Examples

## new_report()

## fx <- folder(delete_me)
## owd <- getwd(); setwd(fx)
## x <- rdirs(admin, 1:15, c("d", "f", "w"), c(1, 4, 6), text.only = TRUE)
## lapply(x, new_report)
## setwd(owd); delete(fx)

trinker/reports documentation built on May 31, 2019, 9:51 p.m.