insertYAML: Insert a YAML header into the R Markdown file

Description Usage Arguments Value Examples

Description

Insert a YAML header into the R Markdown file

Usage

1
2
insertYAML(filename, title = NULL, author = NULL, date = NULL,
  output = "html_document")

Arguments

filename

The name of the file, including the .Rmd extension, into which the YAML header should be inserted

title

Character giving the title of the document

author

Character giving the author's name

date

If NULL inserts Sys.Date() into the date field.

output

The document type that will be generated, e.g. "html_document", "pdf"

Value

Returns the filename to allow chaining with other insert functions

Examples

1
2
3
4
5
6
7
## Not run: 

createFile("Test File") %>%
          insertYAML(title = "Test Report",
                     author = "J. Bloggs",)

## End(Not run)

elastacloud/automatic-data-explorer documentation built on May 8, 2019, 9:29 a.m.