Skip to contents

Knit R Markdown file to results folder

knit_to_results.Rd

This function is used in the YAML of an R Markdown file so that when it is knitted, the output file is sent to the ~/results directory rather than the directory in which the .Rmd file is located. The output file can be .pdf, .html, .md etc.

Usage

knit_to_results(input_file, encoding, envir = parent.frame(), rename_md = TRUE)

Arguments

input_file

The name of the R Markdown file to be rendered.

encoding

Ignored. The encoding is always assumed to be UTF-8.

envir

The environment in which the code chunks are to be evaluated during knitting. If new.env() is used to guarantee an empty new environment, note that save.image() will not, by default save, save the objects created in the Rmd.

rename_md

Logical. If TRUE, the generated .md file will be renamed to README.md to be display on GitHub.

Details

NB. This function does NOT cause any objects that are written to file in your .Rmd code to be written to the new results directory by default. To ensure all objects are written to the correct directories, specify an output_dir directly in the code.