WikiPage: Constructor for WikiPage

In Sage-Bionetworks/rSynapseClient: Synapse R Client from Sage Bionetworks

Description

Constructor for WikiPage

Usage

WikiPage(owner, title="Wiki Page for Entity", markdown="markdown goes here", attachments=list(file1, file2, ...) )
WikiPage(owner, title="Sub-Wiki Page for Entity", markdown="sub-page markdown goes here", parentWikiId="123456")

Details

This creates a wiki page (in memory), or sub-page beneath an existing page for the given entity.

Slots

createUri

uri to create this WikiPage

updateUri

uri to update this WikiPage

attachments

attachments to be uploaded with the WikiPage

properties

Synapse properties for a WikiPage. Properties of interest include:

id

unique Synapse ID as set by the system upon synStore (not set by user)

parentWikiId

the id of another WikiPage, if this WikiPage is a subpage of another WikiPage

title

user supplied title for the WikiPage

markdown

character string containing the markdown to be rendered on the WikiPage

See Also

synGetWiki synStore

Examples

## Not run: 
entity<-synGet("syn123456")
page<-WikiPage(owner=entity, title="Wiki Page for Entity", markdown="markdown goes here")
page<-synStore(page)

## End(Not run)

Sage-Bionetworks/rSynapseClient documentation built on May 9, 2019, 7:04 p.m.