https://github.com/Sage-Bionetworks/knit2synapse
Functionality to knit RMarkdown documents to Synapse wiki pages.
https://github.com/Sage-Bionetworks/knit2synapse
Last synced: about 1 month ago
JSON representation
Functionality to knit RMarkdown documents to Synapse wiki pages.
- Host: GitHub
- URL: https://github.com/Sage-Bionetworks/knit2synapse
- Owner: Sage-Bionetworks
- Created: 2015-04-27T17:34:37.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-10-02T23:09:05.000Z (over 5 years ago)
- Last Synced: 2024-04-11T01:25:14.051Z (about 1 year ago)
- Language: R
- Size: 51.8 KB
- Stars: 4
- Watchers: 6
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-synapse - knit2synapse - Knit Rmarkdown files to Synapse wikis (R)
README
## knit2synapse: Knit RMarkdown files to Synapse wikis.
> This version has [synapser](https://github.com/Sage-Bionetworks/synapser) as a dependency. The last version of this package to use the [rSynapseClient](https://github.com/Sage-Bionetworks/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](http://help.github.com/fork-a-repo/) the [main repo](https://github.com/Sage-Bionetworks/knit2synapse), branch off a [feature branch](https://www.google.com/search?q=git+feature+branches) from `master`, make your changes and [commit](http://git-scm.com/docs/git-commit) them, [push](http://git-scm.com/docs/git-push) to your fork and submit a [pull request](http://help.github.com/send-pull-requests/) for `Sage-Bionetworks/knit2synapse:develop`.