sdk/R/man/Collection.Rd

   1 % Generated by roxygen2: do not edit by hand\r
   2 % Please edit documentation in R/Collection.R\r
   3 \name{Collection}\r
   4 \alias{Collection}\r
   5 \title{R6 Class Representing Arvados Collection}\r
   6 \description{\r
   7 Collection class provides interface for working with Arvados collections,\r
   8 for exaplme actions like creating, updating, moving or removing are possible.\r
   9 }\r
  10 \examples{\r
  11 \r
  12 ## ------------------------------------------------\r
  13 ## Method `Collection$new`\r
  14 ## ------------------------------------------------\r
  15 \r
  16 collection <- Collection$new(arv, CollectionUUID)\r
  17 \r
  18 ## ------------------------------------------------\r
  19 ## Method `Collection$readArvFile`\r
  20 ## ------------------------------------------------\r
  21 \r
  22 collection <- Collection$new(arv, collectionUUID)\r
  23 readFile <- collection$readArvFile(arvadosFile, istable = 'yes')                    # table\r
  24 readFile <- collection$readArvFile(arvadosFile, istable = 'no')                     # text\r
  25 readFile <- collection$readArvFile(arvadosFile)                                     # xlsx, csv, tsv, rds, rdata\r
  26 readFile <- collection$readArvFile(arvadosFile, fileclass = 'lala')                 # fasta\r
  27 readFile <- collection$readArvFile(arvadosFile, Ncol= 4, Nrow = 32)                 # binary, only numbers\r
  28 readFile <- collection$readArvFile(arvadosFile, Ncol = 5, Nrow = 150, istable = "factor") # binary with factor or text\r
  29 \r
  30 ## ------------------------------------------------\r
  31 ## Method `Collection$writeFile`\r
  32 ## ------------------------------------------------\r
  33 \r
  34 collection <- Collection$new(arv, collectionUUID)\r
  35 writeFile <- collection$writeFile(name = "myoutput.csv", file = file, fileFormat = "csv", istable = NULL, collectionUUID = collectionUUID)             # csv\r
  36 writeFile <- collection$writeFile(name = "myoutput.tsv", file = file, fileFormat = "tsv", istable = NULL, collectionUUID = collectionUUID)             # tsv\r
  37 writeFile <- collection$writeFile(name = "myoutput.fasta", file = file, fileFormat = "fasta", istable = NULL, collectionUUID = collectionUUID)         # fasta\r
  38 writeFile <- collection$writeFile(name = "myoutputtable.txt", file = file, fileFormat = "txt", istable = "yes", collectionUUID = collectionUUID)       # txt table\r
  39 writeFile <- collection$writeFile(name = "myoutputtext.txt", file = file, fileFormat = "txt", istable = "no", collectionUUID = collectionUUID)         # txt text\r
  40 writeFile <- collection$writeFile(name = "myoutputbinary.dat", file = file, fileFormat = "dat", collectionUUID = collectionUUID)                       # binary\r
  41 writeFile <- collection$writeFile(name = "myoutputxlsx.xlsx", file = file, fileFormat = "xlsx", collectionUUID = collectionUUID)                       # xlsx\r
  42 \r
  43 ## ------------------------------------------------\r
  44 ## Method `Collection$create`\r
  45 ## ------------------------------------------------\r
  46 \r
  47 collection <- arv$collections_create(name = collectionTitle, description = collectionDescription, owner_uuid = collectionOwner, properties = list("ROX37196928443768648" = "ROX37742976443830153"))\r
  48 \r
  49 ## ------------------------------------------------\r
  50 ## Method `Collection$remove`\r
  51 ## ------------------------------------------------\r
  52 \r
  53 collection$remove(fileName.format)\r
  54 \r
  55 ## ------------------------------------------------\r
  56 ## Method `Collection$move`\r
  57 ## ------------------------------------------------\r
  58 \r
  59 collection$move("fileName.format", path)\r
  60 \r
  61 ## ------------------------------------------------\r
  62 ## Method `Collection$copy`\r
  63 ## ------------------------------------------------\r
  64 \r
  65 copied <- collection$copy("oldName.format", "newName.format")\r
  66 \r
  67 ## ------------------------------------------------\r
  68 ## Method `Collection$refresh`\r
  69 ## ------------------------------------------------\r
  70 \r
  71 collection$refresh()\r
  72 \r
  73 ## ------------------------------------------------\r
  74 ## Method `Collection$getFileListing`\r
  75 ## ------------------------------------------------\r
  76 \r
  77 list <- collection$getFileListing()\r
  78 \r
  79 ## ------------------------------------------------\r
  80 ## Method `Collection$get`\r
  81 ## ------------------------------------------------\r
  82 \r
  83 arvadosFile <- collection$get(fileName)\r
  84 }\r
  85 \seealso{\r
  86 \code{\link{https://github.com/arvados/arvados/tree/main/sdk/R}}\r
  87 }\r
  88 \section{Public fields}{\r
  89 \if{html}{\out{<div class="r6-fields">}}\r
  90 \describe{\r
  91 \item{\code{uuid}}{Autentic for Collection UUID.}\r
  92 }\r
  93 \if{html}{\out{</div>}}\r
  94 }\r
  95 \section{Methods}{\r
  96 \subsection{Public methods}{\r
  97 \itemize{\r
  98 \item \href{#method-new}{\code{Collection$new()}}\r
  99 \item \href{#method-add}{\code{Collection$add()}}\r
 100 \item \href{#method-readArvFile}{\code{Collection$readArvFile()}}\r
 101 \item \href{#method-writeFile}{\code{Collection$writeFile()}}\r
 102 \item \href{#method-create}{\code{Collection$create()}}\r
 103 \item \href{#method-remove}{\code{Collection$remove()}}\r
 104 \item \href{#method-move}{\code{Collection$move()}}\r
 105 \item \href{#method-copy}{\code{Collection$copy()}}\r
 106 \item \href{#method-refresh}{\code{Collection$refresh()}}\r
 107 \item \href{#method-getFileListing}{\code{Collection$getFileListing()}}\r
 108 \item \href{#method-get}{\code{Collection$get()}}\r
 109 \item \href{#method-getRESTService}{\code{Collection$getRESTService()}}\r
 110 \item \href{#method-setRESTService}{\code{Collection$setRESTService()}}\r
 111 }\r
 112 }\r
 113 \if{html}{\out{<hr>}}\r
 114 \if{html}{\out{<a id="method-new"></a>}}\r
 115 \if{latex}{\out{\hypertarget{method-new}{}}}\r
 116 \subsection{Method \code{new()}}{\r
 117 Initialize new enviroment.\r
 118 \subsection{Usage}{\r
 119 \if{html}{\out{<div class="r">}}\preformatted{Collection$new(api, uuid)}\if{html}{\out{</div>}}\r
 120 }\r
 121 \r
 122 \subsection{Arguments}{\r
 123 \if{html}{\out{<div class="arguments">}}\r
 124 \describe{\r
 125 \item{\code{api}}{Arvados enviroment.}\r
 126 \r
 127 \item{\code{uuid}}{The UUID Autentic for Collection UUID.}\r
 128 }\r
 129 \if{html}{\out{</div>}}\r
 130 }\r
 131 \subsection{Returns}{\r
 132 A new `Collection` object.\r
 133 }\r
 134 \subsection{Examples}{\r
 135 \if{html}{\out{<div class="r example copy">}}\r
 136 \preformatted{collection <- Collection$new(arv, CollectionUUID)\r
 137 }\r
 138 \if{html}{\out{</div>}}\r
 139 \r
 140 }\r
 141 \r
 142 }\r
 143 \if{html}{\out{<hr>}}\r
 144 \if{html}{\out{<a id="method-add"></a>}}\r
 145 \if{latex}{\out{\hypertarget{method-add}{}}}\r
 146 \subsection{Method \code{add()}}{\r
 147 Adds ArvadosFile or Subcollection specified by content to the collection. Used only with ArvadosFile or Subcollection.\r
 148 \subsection{Usage}{\r
 149 \if{html}{\out{<div class="r">}}\preformatted{Collection$add(content, relativePath = "")}\if{html}{\out{</div>}}\r
 150 }\r
 151 \r
 152 \subsection{Arguments}{\r
 153 \if{html}{\out{<div class="arguments">}}\r
 154 \describe{\r
 155 \item{\code{content}}{Content to be added.}\r
 156 \r
 157 \item{\code{relativePath}}{Path to add content.}\r
 158 }\r
 159 \if{html}{\out{</div>}}\r
 160 }\r
 161 }\r
 162 \if{html}{\out{<hr>}}\r
 163 \if{html}{\out{<a id="method-readArvFile"></a>}}\r
 164 \if{latex}{\out{\hypertarget{method-readArvFile}{}}}\r
 165 \subsection{Method \code{readArvFile()}}{\r
 166 Read file content.\r
 167 \subsection{Usage}{\r
 168 \if{html}{\out{<div class="r">}}\preformatted{Collection$readArvFile(\r
 169   file,\r
 170   con,\r
 171   sep = ",",\r
 172   istable = NULL,\r
 173   fileclass = "SeqFastadna",\r
 174   Ncol = NULL,\r
 175   Nrow = NULL,\r
 176   wantedFunction = NULL\r
 177 )}\if{html}{\out{</div>}}\r
 178 }\r
 179 \r
 180 \subsection{Arguments}{\r
 181 \if{html}{\out{<div class="arguments">}}\r
 182 \describe{\r
 183 \item{\code{file}}{Name of the file.}\r
 184 \r
 185 \item{\code{sep}}{Separator used in reading tsv, csv file format.}\r
 186 \r
 187 \item{\code{istable}}{Used in reading txt file to check if the file is table or not.}\r
 188 \r
 189 \item{\code{fileclass}}{Used in reading fasta file to set file class.}\r
 190 \r
 191 \item{\code{Ncol}}{Used in reading binary file to set numbers of columns in data.frame.}\r
 192 \r
 193 \item{\code{Nrow}}{Used in reading binary file to set numbers of rows in data.frame size.}\r
 194 \r
 195 \item{\code{col}}{Collection from which the file is read.}\r
 196 }\r
 197 \if{html}{\out{</div>}}\r
 198 }\r
 199 \subsection{Examples}{\r
 200 \if{html}{\out{<div class="r example copy">}}\r
 201 \preformatted{collection <- Collection$new(arv, collectionUUID)\r
 202 readFile <- collection$readArvFile(arvadosFile, istable = 'yes')                    # table\r
 203 readFile <- collection$readArvFile(arvadosFile, istable = 'no')                     # text\r
 204 readFile <- collection$readArvFile(arvadosFile)                                     # xlsx, csv, tsv, rds, rdata\r
 205 readFile <- collection$readArvFile(arvadosFile, fileclass = 'lala')                 # fasta\r
 206 readFile <- collection$readArvFile(arvadosFile, Ncol= 4, Nrow = 32)                 # binary, only numbers\r
 207 readFile <- collection$readArvFile(arvadosFile, Ncol = 5, Nrow = 150, istable = "factor") # binary with factor or text\r
 208 }\r
 209 \if{html}{\out{</div>}}\r
 210 \r
 211 }\r
 212 \r
 213 }\r
 214 \if{html}{\out{<hr>}}\r
 215 \if{html}{\out{<a id="method-writeFile"></a>}}\r
 216 \if{latex}{\out{\hypertarget{method-writeFile}{}}}\r
 217 \subsection{Method \code{writeFile()}}{\r
 218 Write file content\r
 219 \subsection{Usage}{\r
 220 \if{html}{\out{<div class="r">}}\preformatted{Collection$writeFile(\r
 221   name,\r
 222   file,\r
 223   collectionUUID,\r
 224   fileFormat,\r
 225   istable = NULL,\r
 226   seqName = NULL\r
 227 )}\if{html}{\out{</div>}}\r
 228 }\r
 229 \r
 230 \subsection{Arguments}{\r
 231 \if{html}{\out{<div class="arguments">}}\r
 232 \describe{\r
 233 \item{\code{name}}{Name of the file.}\r
 234 \r
 235 \item{\code{file}}{File to be saved.}\r
 236 \r
 237 \item{\code{istable}}{Used in writing txt file to check if the file is table or not.}\r
 238 }\r
 239 \if{html}{\out{</div>}}\r
 240 }\r
 241 \subsection{Examples}{\r
 242 \if{html}{\out{<div class="r example copy">}}\r
 243 \preformatted{collection <- Collection$new(arv, collectionUUID)\r
 244 writeFile <- collection$writeFile(name = "myoutput.csv", file = file, fileFormat = "csv", istable = NULL, collectionUUID = collectionUUID)             # csv\r
 245 writeFile <- collection$writeFile(name = "myoutput.tsv", file = file, fileFormat = "tsv", istable = NULL, collectionUUID = collectionUUID)             # tsv\r
 246 writeFile <- collection$writeFile(name = "myoutput.fasta", file = file, fileFormat = "fasta", istable = NULL, collectionUUID = collectionUUID)         # fasta\r
 247 writeFile <- collection$writeFile(name = "myoutputtable.txt", file = file, fileFormat = "txt", istable = "yes", collectionUUID = collectionUUID)       # txt table\r
 248 writeFile <- collection$writeFile(name = "myoutputtext.txt", file = file, fileFormat = "txt", istable = "no", collectionUUID = collectionUUID)         # txt text\r
 249 writeFile <- collection$writeFile(name = "myoutputbinary.dat", file = file, fileFormat = "dat", collectionUUID = collectionUUID)                       # binary\r
 250 writeFile <- collection$writeFile(name = "myoutputxlsx.xlsx", file = file, fileFormat = "xlsx", collectionUUID = collectionUUID)                       # xlsx\r
 251 }\r
 252 \if{html}{\out{</div>}}\r
 253 \r
 254 }\r
 255 \r
 256 }\r
 257 \if{html}{\out{<hr>}}\r
 258 \if{html}{\out{<a id="method-create"></a>}}\r
 259 \if{latex}{\out{\hypertarget{method-create}{}}}\r
 260 \subsection{Method \code{create()}}{\r
 261 Creates one or more ArvadosFiles and adds them to the collection at specified path.\r
 262 \subsection{Usage}{\r
 263 \if{html}{\out{<div class="r">}}\preformatted{Collection$create(files)}\if{html}{\out{</div>}}\r
 264 }\r
 265 \r
 266 \subsection{Arguments}{\r
 267 \if{html}{\out{<div class="arguments">}}\r
 268 \describe{\r
 269 \item{\code{files}}{Content to be created.}\r
 270 }\r
 271 \if{html}{\out{</div>}}\r
 272 }\r
 273 \subsection{Examples}{\r
 274 \if{html}{\out{<div class="r example copy">}}\r
 275 \preformatted{collection <- arv$collections_create(name = collectionTitle, description = collectionDescription, owner_uuid = collectionOwner, properties = list("ROX37196928443768648" = "ROX37742976443830153"))\r
 276 }\r
 277 \if{html}{\out{</div>}}\r
 278 \r
 279 }\r
 280 \r
 281 }\r
 282 \if{html}{\out{<hr>}}\r
 283 \if{html}{\out{<a id="method-remove"></a>}}\r
 284 \if{latex}{\out{\hypertarget{method-remove}{}}}\r
 285 \subsection{Method \code{remove()}}{\r
 286 Remove one or more files from the collection.\r
 287 \subsection{Usage}{\r
 288 \if{html}{\out{<div class="r">}}\preformatted{Collection$remove(paths)}\if{html}{\out{</div>}}\r
 289 }\r
 290 \r
 291 \subsection{Arguments}{\r
 292 \if{html}{\out{<div class="arguments">}}\r
 293 \describe{\r
 294 \item{\code{paths}}{Content to be removed.}\r
 295 }\r
 296 \if{html}{\out{</div>}}\r
 297 }\r
 298 \subsection{Examples}{\r
 299 \if{html}{\out{<div class="r example copy">}}\r
 300 \preformatted{collection$remove(fileName.format)\r
 301 }\r
 302 \if{html}{\out{</div>}}\r
 303 \r
 304 }\r
 305 \r
 306 }\r
 307 \if{html}{\out{<hr>}}\r
 308 \if{html}{\out{<a id="method-move"></a>}}\r
 309 \if{latex}{\out{\hypertarget{method-move}{}}}\r
 310 \subsection{Method \code{move()}}{\r
 311 Moves ArvadosFile or Subcollection to another location in the collection.\r
 312 \subsection{Usage}{\r
 313 \if{html}{\out{<div class="r">}}\preformatted{Collection$move(content, destination)}\if{html}{\out{</div>}}\r
 314 }\r
 315 \r
 316 \subsection{Arguments}{\r
 317 \if{html}{\out{<div class="arguments">}}\r
 318 \describe{\r
 319 \item{\code{content}}{Content to be moved.}\r
 320 \r
 321 \item{\code{destination}}{Path to move content.}\r
 322 }\r
 323 \if{html}{\out{</div>}}\r
 324 }\r
 325 \subsection{Examples}{\r
 326 \if{html}{\out{<div class="r example copy">}}\r
 327 \preformatted{collection$move("fileName.format", path)\r
 328 }\r
 329 \if{html}{\out{</div>}}\r
 330 \r
 331 }\r
 332 \r
 333 }\r
 334 \if{html}{\out{<hr>}}\r
 335 \if{html}{\out{<a id="method-copy"></a>}}\r
 336 \if{latex}{\out{\hypertarget{method-copy}{}}}\r
 337 \subsection{Method \code{copy()}}{\r
 338 Copies ArvadosFile or Subcollection to another location in the collection.\r
 339 \subsection{Usage}{\r
 340 \if{html}{\out{<div class="r">}}\preformatted{Collection$copy(content, destination)}\if{html}{\out{</div>}}\r
 341 }\r
 342 \r
 343 \subsection{Arguments}{\r
 344 \if{html}{\out{<div class="arguments">}}\r
 345 \describe{\r
 346 \item{\code{content}}{Content to be moved.}\r
 347 \r
 348 \item{\code{destination}}{Path to move content.}\r
 349 }\r
 350 \if{html}{\out{</div>}}\r
 351 }\r
 352 \subsection{Examples}{\r
 353 \if{html}{\out{<div class="r example copy">}}\r
 354 \preformatted{copied <- collection$copy("oldName.format", "newName.format")\r
 355 }\r
 356 \if{html}{\out{</div>}}\r
 357 \r
 358 }\r
 359 \r
 360 }\r
 361 \if{html}{\out{<hr>}}\r
 362 \if{html}{\out{<a id="method-refresh"></a>}}\r
 363 \if{latex}{\out{\hypertarget{method-refresh}{}}}\r
 364 \subsection{Method \code{refresh()}}{\r
 365 Refreshes the environment.\r
 366 \subsection{Usage}{\r
 367 \if{html}{\out{<div class="r">}}\preformatted{Collection$refresh()}\if{html}{\out{</div>}}\r
 368 }\r
 369 \r
 370 \subsection{Examples}{\r
 371 \if{html}{\out{<div class="r example copy">}}\r
 372 \preformatted{collection$refresh()\r
 373 }\r
 374 \if{html}{\out{</div>}}\r
 375 \r
 376 }\r
 377 \r
 378 }\r
 379 \if{html}{\out{<hr>}}\r
 380 \if{html}{\out{<a id="method-getFileListing"></a>}}\r
 381 \if{latex}{\out{\hypertarget{method-getFileListing}{}}}\r
 382 \subsection{Method \code{getFileListing()}}{\r
 383 Returns collections file content as character vector.\r
 384 \subsection{Usage}{\r
 385 \if{html}{\out{<div class="r">}}\preformatted{Collection$getFileListing()}\if{html}{\out{</div>}}\r
 386 }\r
 387 \r
 388 \subsection{Examples}{\r
 389 \if{html}{\out{<div class="r example copy">}}\r
 390 \preformatted{list <- collection$getFileListing()\r
 391 }\r
 392 \if{html}{\out{</div>}}\r
 393 \r
 394 }\r
 395 \r
 396 }\r
 397 \if{html}{\out{<hr>}}\r
 398 \if{html}{\out{<a id="method-get"></a>}}\r
 399 \if{latex}{\out{\hypertarget{method-get}{}}}\r
 400 \subsection{Method \code{get()}}{\r
 401 If relativePath is valid, returns ArvadosFile or Subcollection specified by relativePath, else returns NULL.\r
 402 \subsection{Usage}{\r
 403 \if{html}{\out{<div class="r">}}\preformatted{Collection$get(relativePath)}\if{html}{\out{</div>}}\r
 404 }\r
 405 \r
 406 \subsection{Arguments}{\r
 407 \if{html}{\out{<div class="arguments">}}\r
 408 \describe{\r
 409 \item{\code{relativePath}}{Path from content is taken.}\r
 410 }\r
 411 \if{html}{\out{</div>}}\r
 412 }\r
 413 \subsection{Examples}{\r
 414 \if{html}{\out{<div class="r example copy">}}\r
 415 \preformatted{arvadosFile <- collection$get(fileName)\r
 416 }\r
 417 \if{html}{\out{</div>}}\r
 418 \r
 419 }\r
 420 \r
 421 }\r
 422 \if{html}{\out{<hr>}}\r
 423 \if{html}{\out{<a id="method-getRESTService"></a>}}\r
 424 \if{latex}{\out{\hypertarget{method-getRESTService}{}}}\r
 425 \subsection{Method \code{getRESTService()}}{\r
 426 \subsection{Usage}{\r
 427 \if{html}{\out{<div class="r">}}\preformatted{Collection$getRESTService()}\if{html}{\out{</div>}}\r
 428 }\r
 429 \r
 430 }\r
 431 \if{html}{\out{<hr>}}\r
 432 \if{html}{\out{<a id="method-setRESTService"></a>}}\r
 433 \if{latex}{\out{\hypertarget{method-setRESTService}{}}}\r
 434 \subsection{Method \code{setRESTService()}}{\r
 435 \subsection{Usage}{\r
 436 \if{html}{\out{<div class="r">}}\preformatted{Collection$setRESTService(newRESTService)}\if{html}{\out{</div>}}\r
 437 }\r
 438 \r
 439 }\r
 440 }\r