search

Sage-Bionetworks / synapser

An R package providing programmatic access to Synapse
Apache License 2.0
32 stars 21 forks source link

SYNR-1165 & SYNR-1206 #209

Closed kimyen closed 5 years ago

kimyen commented 5 years ago

@kelshmo could you look over the examples in reference docs and see if they are useful to you?

kelshmo commented 5 years ago

  1. @kimyen It would be helpful if we had examples of how to add content to a Wiki beyond text. What types can the markdown argument accept?

  2. add documentation to demonstrate owner argument takes a "synId"

  3. It would be helpful if the attachments argument had more examples. In fact, the way it is written now, I'm not sure how to even add attachments. Does attachments take any file type? When I run attachments with a character string to my file path, I do not see the file displayed in the Wiki.

filePath <- tempfile()
wiki <- Wiki(owner = project,
                 title = "My Wiki Page",
                 markdown = content,
                 attachments = list(filePath))
kimyen commented 5 years ago

Thanks @kelshmo !

It would be helpful if we had examples of how to add content to a Wiki beyond text.

I think we had bold (emphasis) in Wiki.rd.

What types can the markdown argument accept?

Do you think this information can be at the Synapse Docs site? And I can link to it from here?

I will address 2.

@kdaily, do you have examples of uploading Wiki with attachments?

kimyen commented 5 years ago

While testing the wiki attachment, I ran into a bug: https://sagebionetworks.jira.com/browse/SYNPY-911. I will be removing attachments in examples.