createAndKnitToFileEntity: createAndKnitToFileEntity

In Sage-Bionetworks/knit2synapse: Knit RMarkdown to a Synapse Wiki page.

Description

Store a local RMarkdown file to Synapse and then knit it to that file's WikiPage.

Usage

createAndKnitToFileEntity(file, parentId, fileName = NULL, wikiName = NULL,
  overwrite = FALSE, knitmd = TRUE, ...)

Arguments

file	path to a local .Rmd file which to knit
parentId	A synapseClient::Project or synapseClient::Folder entity (or Synapse ID of an entity) where the File will be created
fileName	Name of the synapseClient::File to create
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). This will remove the history of changes for this Wiki page.
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.