sdk/R/man/Arvados.Rd

   1 % Generated by roxygen2: do not edit by hand
   2 % Please edit documentation in R/Arvados.R
   3 \name{Arvados}
   4 \alias{Arvados}
   5 \title{Arvados}
   6 \description{
   7 Arvados class gives users ability to manipulate collections and projects.
   8 }
   9 \section{Usage}{
  10
  11 \preformatted{arv = Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}
  12 }
  13
  14 \section{Arguments}{
  15
  16 \describe{
  17   \item{authToken}{Authentification token. If not specified ARVADOS_API_TOKEN environment variable will be used.}
  18   \item{hostName}{Host name. If not specified ARVADOS_API_HOST environment variable will be used.}
  19   \item{numRetries}{Number which specifies how many times to retry failed service requests.}
  20 }
  21 }
  22
  23 \section{Methods}{
  24
  25 \describe{
  26   \item{getToken()}{Returns authentification token currently in use.}
  27   \item{getHostName()}{Returns host name currently in use.}
  28   \item{getNumRetries()}{Returns number which specifies how many times to retry failed service requests.}
  29   \item{setNumRetries(newNumOfRetries)}{Sets number which specifies how many times to retry failed service requests.}
  30   \item{getCollection(uuid)}{Get collection with specified UUID.}
  31   \item{listCollections(filters = NULL, limit = 100, offset = 0)}{Returns list of collections based on filters parameter.}
  32   \item{listAllCollections(filters = NULL)}{Lists all collections, based on filters parameter, even if the number of items is greater than maximum API limit.}
  33   \item{deleteCollection(uuid)}{Deletes collection with specified UUID.}
  34   \item{updateCollection(uuid, newContent)}{Updates collection with specified UUID.}
  35   \item{createCollection(content)}{Creates new collection.}
  36   \item{getProject(uuid)}{Get project with specified UUID.}
  37   \item{listProjects(filters = NULL, limit = 100, offset = 0)}{Returns list of projects based on filters parameter.}
  38   \item{listAllProjects(filters = NULL)}{Lists all projects, based on filters parameter, even if the number of items is greater than maximum API limit.}
  39   \item{deleteProject(uuid)}{Deletes project with specified UUID.}
  40   \item{updateProject(uuid, newContent)}{Updates project with specified UUID.}
  41   \item{createProject(content)}{Creates new project.}
  42 }
  43 }
  44
  45 \examples{
  46 \dontrun{
  47 arv <- Arvados$new("your Arvados token", "example.arvadosapi.com")
  48
  49 collection <- arv$getCollection("uuid")
  50
  51 collectionList <- arv$listCollections(list(list("name", "like", "Test\%")))
  52 collectionList <- arv$listAllCollections(list(list("name", "like", "Test\%")))
  53
  54 deletedCollection <- arv$deleteCollection("uuid")
  55
  56 updatedCollection <- arv$updateCollection("uuid", list(name = "New name",
  57                                                        description = "New description"))
  58
  59 createdCollection <- arv$createCollection(list(name = "Example",
  60                                                description = "This is a test collection"))
  61 }
  62 }