knitfile2synapse: knitfile2synapse

Description Usage Arguments Value

Description

Allow users to leverage knitr when constructing Synapse Wiki content

Usage

1
2
knitfile2synapse(file, owner, parentWikiId = NULL, wikiName = NULL,
  overwrite = FALSE, knitmd = TRUE)

Arguments

file

path to a local .Rmd file which to knit

owner

A Synapse object which will own the resulting WikiPage (usually a Project, Folder, or File)

parentWikiId

If the resulting WikiPage is to be a subpage of another WikiPage, this is the id for the parent WikiPage (NOTE: owner is still required)

wikiName

A title for the resulting WikiPage - will default to the file name without the .Rmd extension

overwrite

Only if owner specified and parentWikiId is NULL - flag for whether or not to overwrite the previous root WikiPage (if it exists)

knitmd

Flag for whether or not to knit; if false and file already exists, don't knit it again

Value

a synapseClient::WikiPage object


Sage-Bionetworks/knit2synapse documentation built on May 9, 2019, 12:12 p.m.