rrtools (version 0.1.5)

use_analysis: Adds an analysis directory (and sub-directories), and an Rmd file ready to write

Description

This will create paper.Rmd, references.bib and several others, and add bookdown to the imported packages listed in the DESCRIPTION file.

Usage

use_analysis(
  pkg = ".",
  location = "top_level",
  template = "paper.Rmd",
  data = list(),
  data_in_git = TRUE
)

Arguments

pkg

defaults to the package in the current working directory

location

the location where the directories and files will be written to. Defaults to a top-level 'analysis' directory. Other options are 'inst' (for the inst/ directory, so that all the contents will be included in the installed package) and 'vignettes' (as in a regular package vignette, all contents will be included in the installed package).

template

the template file to use to create the main analysis document. Defaults to 'paper.Rmd', ready to write R Markdown and knit to MS Word using bookdown

data

forwarded to whisker::whisker.render

data_in_git

should git track the files in the data directory?