SYNR-1279 #5
SYNR-1279 #5
Conversation
README.Rmd
Outdated
|
|
||
| The example below copy File ID `syn123` to Project ID `syn456`: | ||
| ```{r eval=F} | ||
| copy("syn123", "syn456") |
There was a problem hiding this comment.
It looks like there's some extra space here and in a couple other code chunks.
There was a problem hiding this comment.
Thanks @karawoo! Do you refer to the spaces before copy or the spaces between the parameters?
There was a problem hiding this comment.
The space before copy. I like the space between the parameters.
README.Rmd
Outdated
| copy("syn123", "syn456") | ||
| ``` | ||
|
|
||
| The first parameter in `copy()` can be a File ID, a Table ID, or a Link ID. The second parameter must be a Folder ID or a Project ID. |
There was a problem hiding this comment.
It appears that copying a folder also works. The documentation for copy() doesn't state what types of entities can be copied; can we put this information there as well?
There was a problem hiding this comment.
For this topic, the copy function in the Python client is not tested. I want to hold off on advertising copying folder (and possibly recursively copy the entire hierarchy) until we refactor and have all test coverage for this function. This refactor would also include the re-write/ edit the copy function documentation in Python. synapserutils will then inherit the new docs. I will update this part then.
README.Rmd
Outdated
|
|
||
| #### Copy Entity (File, Folder, Table, Link, and Project) | ||
|
|
||
| The example below copy File ID `syn123` to Project ID `syn456`: |
README.Rmd
Outdated
|
|
||
| # synapserutils | ||
|
|
||
| The `synapserutils` package provides a set of utility functions, built on top of [`synapser`](http://sage-bionetworks.github.io/synapser/) package. |
There was a problem hiding this comment.
built on top of the synapser package
README.Rmd
Outdated
|
|
||
| #### Copy Wiki and Wiki Subpage | ||
|
|
||
| To copy a wiki page that associate with an Entity (Project/ File/ Folder/ Table) `syn123` to another Entity `syn789`: |
README.Rmd
Outdated
| syncToSynapse("/path/to/manifest.tsv") | ||
| ``` | ||
|
|
||
| The manifest file format and instructions on how to create one could be found [here](http://docs.synapse.org/articles/uploading_in_bulk.html#creating-a-manifest) and by: |
|
Looks good! |
No description provided.