sdk/R/man/Subcollection.Rd

   1 % Generated by roxygen2: do not edit by hand\r
   2 % Please edit documentation in R/Subcollection.R\r
   3 \name{Subcollection}\r
   4 \alias{Subcollection}\r
   5 \title{R6 Class Representing a Subcollection}\r
   6 \description{\r
   7 Subcollection class represents a folder inside Arvados collection.\r
   8 It is essentially a composite of arvadosFiles and other subcollections.\r
   9 }\r
  10 \section{Methods}{\r
  11 \subsection{Public methods}{\r
  12 \itemize{\r
  13 \item \href{#method-new}{\code{Subcollection$new()}}\r
  14 \item \href{#method-getName}{\code{Subcollection$getName()}}\r
  15 \item \href{#method-getRelativePath}{\code{Subcollection$getRelativePath()}}\r
  16 \item \href{#method-add}{\code{Subcollection$add()}}\r
  17 \item \href{#method-remove}{\code{Subcollection$remove()}}\r
  18 \item \href{#method-getFileListing}{\code{Subcollection$getFileListing()}}\r
  19 \item \href{#method-getSizeInBytes}{\code{Subcollection$getSizeInBytes()}}\r
  20 \item \href{#method-move}{\code{Subcollection$move()}}\r
  21 \item \href{#method-copy}{\code{Subcollection$copy()}}\r
  22 \item \href{#method-duplicate}{\code{Subcollection$duplicate()}}\r
  23 \item \href{#method-get}{\code{Subcollection$get()}}\r
  24 \item \href{#method-getFirst}{\code{Subcollection$getFirst()}}\r
  25 \item \href{#method-setCollection}{\code{Subcollection$setCollection()}}\r
  26 \item \href{#method-getCollection}{\code{Subcollection$getCollection()}}\r
  27 \item \href{#method-getParent}{\code{Subcollection$getParent()}}\r
  28 \item \href{#method-setParent}{\code{Subcollection$setParent()}}\r
  29 }\r
  30 }\r
  31 \if{html}{\out{<hr>}}\r
  32 \if{html}{\out{<a id="method-new"></a>}}\r
  33 \if{latex}{\out{\hypertarget{method-new}{}}}\r
  34 \subsection{Method \code{new()}}{\r
  35 Initialize new enviroment.\r
  36 \subsection{Usage}{\r
  37 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$new(name)}\if{html}{\out{</div>}}\r
  38 }\r
  39 \r
  40 \subsection{Arguments}{\r
  41 \if{html}{\out{<div class="arguments">}}\r
  42 \describe{\r
  43 \item{\code{name}}{Name of the new enviroment.}\r
  44 }\r
  45 \if{html}{\out{</div>}}\r
  46 }\r
  47 \subsection{Returns}{\r
  48 A new `Subcollection` object.\r
  49 }\r
  50 }\r
  51 \if{html}{\out{<hr>}}\r
  52 \if{html}{\out{<a id="method-getName"></a>}}\r
  53 \if{latex}{\out{\hypertarget{method-getName}{}}}\r
  54 \subsection{Method \code{getName()}}{\r
  55 Returns name of the file.\r
  56 \subsection{Usage}{\r
  57 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$getName()}\if{html}{\out{</div>}}\r
  58 }\r
  59 \r
  60 }\r
  61 \if{html}{\out{<hr>}}\r
  62 \if{html}{\out{<a id="method-getRelativePath"></a>}}\r
  63 \if{latex}{\out{\hypertarget{method-getRelativePath}{}}}\r
  64 \subsection{Method \code{getRelativePath()}}{\r
  65 Returns Subcollection's path relative to the root.\r
  66 \subsection{Usage}{\r
  67 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$getRelativePath()}\if{html}{\out{</div>}}\r
  68 }\r
  69 \r
  70 }\r
  71 \if{html}{\out{<hr>}}\r
  72 \if{html}{\out{<a id="method-add"></a>}}\r
  73 \if{latex}{\out{\hypertarget{method-add}{}}}\r
  74 \subsection{Method \code{add()}}{\r
  75 Adds ArvadosFile or Subcollection specified by content to the Subcollection.\r
  76 \subsection{Usage}{\r
  77 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$add(content)}\if{html}{\out{</div>}}\r
  78 }\r
  79 \r
  80 \subsection{Arguments}{\r
  81 \if{html}{\out{<div class="arguments">}}\r
  82 \describe{\r
  83 \item{\code{content}}{Content to be added.}\r
  84 }\r
  85 \if{html}{\out{</div>}}\r
  86 }\r
  87 }\r
  88 \if{html}{\out{<hr>}}\r
  89 \if{html}{\out{<a id="method-remove"></a>}}\r
  90 \if{latex}{\out{\hypertarget{method-remove}{}}}\r
  91 \subsection{Method \code{remove()}}{\r
  92 Removes ArvadosFile or Subcollection specified by name from the Subcollection.\r
  93 \subsection{Usage}{\r
  94 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$remove(name)}\if{html}{\out{</div>}}\r
  95 }\r
  96 \r
  97 \subsection{Arguments}{\r
  98 \if{html}{\out{<div class="arguments">}}\r
  99 \describe{\r
 100 \item{\code{name}}{Name of the file to be removed.}\r
 101 }\r
 102 \if{html}{\out{</div>}}\r
 103 }\r
 104 }\r
 105 \if{html}{\out{<hr>}}\r
 106 \if{html}{\out{<a id="method-getFileListing"></a>}}\r
 107 \if{latex}{\out{\hypertarget{method-getFileListing}{}}}\r
 108 \subsection{Method \code{getFileListing()}}{\r
 109 Returns Subcollections file content as character vector.\r
 110 \subsection{Usage}{\r
 111 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$getFileListing(fullPath = TRUE)}\if{html}{\out{</div>}}\r
 112 }\r
 113 \r
 114 \subsection{Arguments}{\r
 115 \if{html}{\out{<div class="arguments">}}\r
 116 \describe{\r
 117 \item{\code{fullPath}}{Checking if the path to file exists.}\r
 118 }\r
 119 \if{html}{\out{</div>}}\r
 120 }\r
 121 }\r
 122 \if{html}{\out{<hr>}}\r
 123 \if{html}{\out{<a id="method-getSizeInBytes"></a>}}\r
 124 \if{latex}{\out{\hypertarget{method-getSizeInBytes}{}}}\r
 125 \subsection{Method \code{getSizeInBytes()}}{\r
 126 Returns subcollections content size in bytes.\r
 127 \subsection{Usage}{\r
 128 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$getSizeInBytes()}\if{html}{\out{</div>}}\r
 129 }\r
 130 \r
 131 }\r
 132 \if{html}{\out{<hr>}}\r
 133 \if{html}{\out{<a id="method-move"></a>}}\r
 134 \if{latex}{\out{\hypertarget{method-move}{}}}\r
 135 \subsection{Method \code{move()}}{\r
 136 Moves Subcollection to a new location inside collection.\r
 137 \subsection{Usage}{\r
 138 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$move(destination)}\if{html}{\out{</div>}}\r
 139 }\r
 140 \r
 141 \subsection{Arguments}{\r
 142 \if{html}{\out{<div class="arguments">}}\r
 143 \describe{\r
 144 \item{\code{destination}}{Path to move the file.}\r
 145 }\r
 146 \if{html}{\out{</div>}}\r
 147 }\r
 148 }\r
 149 \if{html}{\out{<hr>}}\r
 150 \if{html}{\out{<a id="method-copy"></a>}}\r
 151 \if{latex}{\out{\hypertarget{method-copy}{}}}\r
 152 \subsection{Method \code{copy()}}{\r
 153 Copies Subcollection to a new location inside collection.\r
 154 \subsection{Usage}{\r
 155 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$copy(destination)}\if{html}{\out{</div>}}\r
 156 }\r
 157 \r
 158 \subsection{Arguments}{\r
 159 \if{html}{\out{<div class="arguments">}}\r
 160 \describe{\r
 161 \item{\code{destination}}{Path to copy the file.}\r
 162 }\r
 163 \if{html}{\out{</div>}}\r
 164 }\r
 165 }\r
 166 \if{html}{\out{<hr>}}\r
 167 \if{html}{\out{<a id="method-duplicate"></a>}}\r
 168 \if{latex}{\out{\hypertarget{method-duplicate}{}}}\r
 169 \subsection{Method \code{duplicate()}}{\r
 170 Duplicate Subcollection and gives it a new name.\r
 171 \subsection{Usage}{\r
 172 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$duplicate(newName = NULL)}\if{html}{\out{</div>}}\r
 173 }\r
 174 \r
 175 \subsection{Arguments}{\r
 176 \if{html}{\out{<div class="arguments">}}\r
 177 \describe{\r
 178 \item{\code{newName}}{New name for duplicated file.}\r
 179 }\r
 180 \if{html}{\out{</div>}}\r
 181 }\r
 182 }\r
 183 \if{html}{\out{<hr>}}\r
 184 \if{html}{\out{<a id="method-get"></a>}}\r
 185 \if{latex}{\out{\hypertarget{method-get}{}}}\r
 186 \subsection{Method \code{get()}}{\r
 187 If name is valid, returns ArvadosFile or Subcollection specified by relativePath, else returns NULL.\r
 188 \subsection{Usage}{\r
 189 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$get(name)}\if{html}{\out{</div>}}\r
 190 }\r
 191 \r
 192 \subsection{Arguments}{\r
 193 \if{html}{\out{<div class="arguments">}}\r
 194 \describe{\r
 195 \item{\code{name}}{Name of the file.}\r
 196 }\r
 197 \if{html}{\out{</div>}}\r
 198 }\r
 199 }\r
 200 \if{html}{\out{<hr>}}\r
 201 \if{html}{\out{<a id="method-getFirst"></a>}}\r
 202 \if{latex}{\out{\hypertarget{method-getFirst}{}}}\r
 203 \subsection{Method \code{getFirst()}}{\r
 204 Returns files in Subcollection.\r
 205 \subsection{Usage}{\r
 206 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$getFirst()}\if{html}{\out{</div>}}\r
 207 }\r
 208 \r
 209 }\r
 210 \if{html}{\out{<hr>}}\r
 211 \if{html}{\out{<a id="method-setCollection"></a>}}\r
 212 \if{latex}{\out{\hypertarget{method-setCollection}{}}}\r
 213 \subsection{Method \code{setCollection()}}{\r
 214 Sets Collection by its UUID.\r
 215 \subsection{Usage}{\r
 216 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$setCollection(collection, setRecursively = TRUE)}\if{html}{\out{</div>}}\r
 217 }\r
 218 \r
 219 }\r
 220 \if{html}{\out{<hr>}}\r
 221 \if{html}{\out{<a id="method-getCollection"></a>}}\r
 222 \if{latex}{\out{\hypertarget{method-getCollection}{}}}\r
 223 \subsection{Method \code{getCollection()}}{\r
 224 Returns Collection of Subcollection.\r
 225 \subsection{Usage}{\r
 226 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$getCollection()}\if{html}{\out{</div>}}\r
 227 }\r
 228 \r
 229 }\r
 230 \if{html}{\out{<hr>}}\r
 231 \if{html}{\out{<a id="method-getParent"></a>}}\r
 232 \if{latex}{\out{\hypertarget{method-getParent}{}}}\r
 233 \subsection{Method \code{getParent()}}{\r
 234 Returns Collection UUID.\r
 235 \subsection{Usage}{\r
 236 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$getParent()}\if{html}{\out{</div>}}\r
 237 }\r
 238 \r
 239 }\r
 240 \if{html}{\out{<hr>}}\r
 241 \if{html}{\out{<a id="method-setParent"></a>}}\r
 242 \if{latex}{\out{\hypertarget{method-setParent}{}}}\r
 243 \subsection{Method \code{setParent()}}{\r
 244 Sets new Collection.\r
 245 \subsection{Usage}{\r
 246 \if{html}{\out{<div class="r">}}\preformatted{Subcollection$setParent(newParent)}\if{html}{\out{</div>}}\r
 247 }\r
 248 \r
 249 }\r
 250 }\r