createMarkdown: Creates an Rmarkdown file in specified directory

Description Usage Arguments Details Value Examples

View source: R/create_markdown.R

Description

Creates an Rmarkdown file in specified directory

Usage

1
2
3
4
5
6
7
8
createMarkdown(
  target.file = paste0(getSourceInfo()$file$file, "md"),
  target.dir = getSourceInfo()$markdown.dir,
  style = "html_document",
  description = "Markdown",
  si,
  overwrite = FALSE
)

Arguments

target.file

Markdown file to create

target.dir

Directory to send target file

style

Markdown target style

description

Markdown description

si

source_info object for tracking

overwrite

overwrite existing R markdown?

Details

Uses rmarkdown library to access objects in the R script. Will track dependencies for objects used within Rmd file.

Value

File information

Examples

1
2
3
4
5
6
## Not run: 
source_info <- create_source_file_dir("adaprHome","tree_controller.R")
#Create markdown file in markdown directory for tree_controller.R
createMarkdown()

## End(Not run) 

gelfondjal/adapr documentation built on Feb. 2, 2020, 1:32 a.m.