projects
/
arvados.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Improve Collections create and move methods and update documentation
[arvados.git]
/
sdk
/
R
/
man
/
Collection.Rd
diff --git
a/sdk/R/man/Collection.Rd
b/sdk/R/man/Collection.Rd
index 8cf29a2ea56d19cc32307cdab3c0a488537ac295..fbe6038664447df230ba77295f17d5df97274d29 100644
(file)
--- a/
sdk/R/man/Collection.Rd
+++ b/
sdk/R/man/Collection.Rd
@@
-23,9
+23,10
@@
Collection class provides interface for working with Arvados collections.
\describe{
\item{add(content)}{Adds ArvadosFile or Subcollection specified by content to the collection.}
\describe{
\item{add(content)}{Adds ArvadosFile or Subcollection specified by content to the collection.}
- \item{create(file
Names, relativePath = ""
)}{Creates one or more ArvadosFiles and adds them to the collection at specified path.}
+ \item{create(file
s
)}{Creates one or more ArvadosFiles and adds them to the collection at specified path.}
\item{remove(fileNames)}{Remove one or more files from the collection.}
\item{remove(fileNames)}{Remove one or more files from the collection.}
- \item{move(content, newLocation)}{Moves ArvadosFile or Subcollection to another location in the collection.}
+ \item{move(content, destination)}{Moves ArvadosFile or Subcollection to another location in the collection.}
+ \item{copy(content, destination)}{Copies ArvadosFile or Subcollection to another location in the collection.}
\item{getFileListing()}{Returns collections file content as character vector.}
\item{get(relativePath)}{If relativePath is valid, returns ArvadosFile or Subcollection specified by relativePath, else returns NULL.}
}
\item{getFileListing()}{Returns collections file content as character vector.}
\item{get(relativePath)}{If relativePath is valid, returns ArvadosFile or Subcollection specified by relativePath, else returns NULL.}
}
@@
-36,9
+37,6
@@
Collection class provides interface for working with Arvados collections.
arv <- Arvados$new("your Arvados token", "example.arvadosapi.com")
collection <- Collection$new(arv, "uuid")
arv <- Arvados$new("your Arvados token", "example.arvadosapi.com")
collection <- Collection$new(arv, "uuid")
-newFile <- ArvadosFile$new("myFile")
-collection$add(newFile, "myFolder")
-
createdFiles <- collection$create(c("main.cpp", lib.dll), "cpp/src/")
collection$remove("location/to/my/file.cpp")
createdFiles <- collection$create(c("main.cpp", lib.dll), "cpp/src/")
collection$remove("location/to/my/file.cpp")