Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.45 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.45 KB

knit2synapse: Knit RMarkdown files to Synapse wikis.

This version has synapser as a dependency. The last version of this package to use the rSynapseClient is v0.1.

Installing

First, install the synapser package:

install.packages("synapser", repos=c("https://sage-bionetworks.github.io/staging-ran", "http://cran.fhcrc.org"))

The, using devtools:

devtools::install_github("Sage-Bionetworks/knit2synapse")

Usage

knitfile2synapse(markdownfile, owner='syn123', parentWikiId = NULL, wikiName = NULL, overwrite = FALSE)

  • markdownfile: a path to a markdown file (including RMarkdown files)
  • owner: The Entity where the Wiki page should go (this can be a Project, File, or Folder entity)
  • parentWikiId: If supplied, will make a sub-Wiki underneath this Wiki ID. Note that this is not a Synapse ID (does not start with syn, it is an integer)

Contributing

To contribute, fork the main repo, branch off a feature branch from master, make your changes and commit them, push to your fork and submit a pull request for Sage-Bionetworks/knit2synapse:develop.