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 add30b1440853167eab966f0b5124b935907f67d..fbe6038664447df230ba77295f17d5df97274d29 100644 (file)
--- a/sdk/R/man/Collection.Rd
+++ b/sdk/R/man/Collection.Rd
@@ -1,67 +1,49 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/arvados_objects.R
+% Please edit documentation in R/Collection.R
 \name{Collection}
 \alias{Collection}
-\title{Collection Object}
-\usage{
-Collection(uuid = NULL, etag = NULL, owner_uuid = NULL,
-  created_at = NULL, modified_by_client_uuid = NULL,
-  modified_by_user_uuid = NULL, modified_at = NULL,
-  portable_data_hash = NULL, replication_desired = NULL,
-  replication_confirmed_at = NULL, replication_confirmed = NULL,
-  updated_at = NULL, manifest_text = NULL, name = NULL,
-  description = NULL, properties = NULL, delete_at = NULL,
-  file_names = NULL, trash_at = NULL, is_trashed = NULL)
+\title{Collection}
+\description{
+Collection class provides interface for working with Arvados collections.
 }
-\arguments{
-\item{uuid}{Object ID}
-
-\item{etag}{Object version}
-
-\item{owner_uuid}{No description}
-
-\item{created_at}{No description}
-
-\item{modified_by_client_uuid}{No description}
-
-\item{modified_by_user_uuid}{No description}
-
-\item{modified_at}{No description}
-
-\item{portable_data_hash}{No description}
-
-\item{replication_desired}{No description}
+\section{Usage}{
 
-\item{replication_confirmed_at}{No description}
-
-\item{replication_confirmed}{No description}
+\preformatted{collection = Collection$new(arv, uuid)}
+}
 
-\item{updated_at}{No description}
+\section{Arguments}{
 
-\item{manifest_text}{No description}
+\describe{
+  \item{arv}{Arvados object.}
+  \item{uuid}{UUID of a collection.}
+}
+}
 
-\item{name}{No description}
+\section{Methods}{
 
-\item{description}{No description}
+\describe{
+  \item{add(content)}{Adds ArvadosFile or Subcollection specified by content to the collection.}
+  \item{create(files)}{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{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{properties}{No description}
+\examples{
+\dontrun{
+arv <- Arvados$new("your Arvados token", "example.arvadosapi.com")
+collection <- Collection$new(arv, "uuid")
 
-\item{delete_at}{No description}
+createdFiles <- collection$create(c("main.cpp", lib.dll), "cpp/src/")
 
-\item{file_names}{No description}
+collection$remove("location/to/my/file.cpp")
 
-\item{trash_at}{No description}
+collection$move("folder/file.cpp", "file.cpp")
 
-\item{is_trashed}{No description}
-}
-\value{
-Collection object
-}
-\description{
-Collection Object
+arvadosFile <- collection$get("location/to/my/file.cpp")
+arvadosSubcollection <- collection$get("location/to/my/directory/")
 }
-\details{
-Todo: Update description
-Collection
 }
-\concept{Collection functions}