-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/Subcollection.R
-\docType{data}
-\name{Subcollection}
-\alias{Subcollection}
-\title{Arvados SubCollection Object}
-\format{An object of class \code{R6ClassGenerator} of length 24.}
-\usage{
-Subcollection
-}
-\description{
-Update description
-}
-\keyword{datasets}
+% Generated by roxygen2: do not edit by hand\r
+% Please edit documentation in R/Subcollection.R\r
+\name{Subcollection}\r
+\alias{Subcollection}\r
+\title{R6 Class Representing a Subcollection}\r
+\description{\r
+Subcollection class represents a folder inside Arvados collection.\r
+It is essentially a composite of arvadosFiles and other subcollections.\r
+}\r
+\section{Methods}{\r
+\subsection{Public methods}{\r
+\itemize{\r
+\item \href{#method-Subcollection-new}{\code{Subcollection$new()}}\r
+\item \href{#method-Subcollection-getName}{\code{Subcollection$getName()}}\r
+\item \href{#method-Subcollection-getRelativePath}{\code{Subcollection$getRelativePath()}}\r
+\item \href{#method-Subcollection-add}{\code{Subcollection$add()}}\r
+\item \href{#method-Subcollection-remove}{\code{Subcollection$remove()}}\r
+\item \href{#method-Subcollection-getFileListing}{\code{Subcollection$getFileListing()}}\r
+\item \href{#method-Subcollection-getSizeInBytes}{\code{Subcollection$getSizeInBytes()}}\r
+\item \href{#method-Subcollection-move}{\code{Subcollection$move()}}\r
+\item \href{#method-Subcollection-copy}{\code{Subcollection$copy()}}\r
+\item \href{#method-Subcollection-duplicate}{\code{Subcollection$duplicate()}}\r
+\item \href{#method-Subcollection-get}{\code{Subcollection$get()}}\r
+\item \href{#method-Subcollection-getFirst}{\code{Subcollection$getFirst()}}\r
+\item \href{#method-Subcollection-setCollection}{\code{Subcollection$setCollection()}}\r
+\item \href{#method-Subcollection-getCollection}{\code{Subcollection$getCollection()}}\r
+\item \href{#method-Subcollection-getParent}{\code{Subcollection$getParent()}}\r
+\item \href{#method-Subcollection-setParent}{\code{Subcollection$setParent()}}\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-new"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-new}{}}}\r
+\subsection{Method \code{new()}}{\r
+Initialize new enviroment.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$new(name)}\if{html}{\out{</div>}}\r
+}\r
+\r
+\subsection{Arguments}{\r
+\if{html}{\out{<div class="arguments">}}\r
+\describe{\r
+\item{\code{name}}{Name of the new enviroment.}\r
+}\r
+\if{html}{\out{</div>}}\r
+}\r
+\subsection{Returns}{\r
+A new `Subcollection` object.\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-getName"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-getName}{}}}\r
+\subsection{Method \code{getName()}}{\r
+Returns name of the file.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$getName()}\if{html}{\out{</div>}}\r
+}\r
+\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-getRelativePath"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-getRelativePath}{}}}\r
+\subsection{Method \code{getRelativePath()}}{\r
+Returns Subcollection's path relative to the root.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$getRelativePath()}\if{html}{\out{</div>}}\r
+}\r
+\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-add"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-add}{}}}\r
+\subsection{Method \code{add()}}{\r
+Adds ArvadosFile or Subcollection specified by content to the Subcollection.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$add(content)}\if{html}{\out{</div>}}\r
+}\r
+\r
+\subsection{Arguments}{\r
+\if{html}{\out{<div class="arguments">}}\r
+\describe{\r
+\item{\code{content}}{Content to be added.}\r
+}\r
+\if{html}{\out{</div>}}\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-remove"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-remove}{}}}\r
+\subsection{Method \code{remove()}}{\r
+Removes ArvadosFile or Subcollection specified by name from the Subcollection.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$remove(name)}\if{html}{\out{</div>}}\r
+}\r
+\r
+\subsection{Arguments}{\r
+\if{html}{\out{<div class="arguments">}}\r
+\describe{\r
+\item{\code{name}}{Name of the file to be removed.}\r
+}\r
+\if{html}{\out{</div>}}\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-getFileListing"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-getFileListing}{}}}\r
+\subsection{Method \code{getFileListing()}}{\r
+Returns Subcollections file content as character vector.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$getFileListing(fullPath = TRUE)}\if{html}{\out{</div>}}\r
+}\r
+\r
+\subsection{Arguments}{\r
+\if{html}{\out{<div class="arguments">}}\r
+\describe{\r
+\item{\code{fullPath}}{Checking if the path to file exists.}\r
+}\r
+\if{html}{\out{</div>}}\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-getSizeInBytes"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-getSizeInBytes}{}}}\r
+\subsection{Method \code{getSizeInBytes()}}{\r
+Returns subcollections content size in bytes.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$getSizeInBytes()}\if{html}{\out{</div>}}\r
+}\r
+\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-move"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-move}{}}}\r
+\subsection{Method \code{move()}}{\r
+Moves Subcollection to a new location inside collection.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$move(destination)}\if{html}{\out{</div>}}\r
+}\r
+\r
+\subsection{Arguments}{\r
+\if{html}{\out{<div class="arguments">}}\r
+\describe{\r
+\item{\code{destination}}{Path to move the file.}\r
+}\r
+\if{html}{\out{</div>}}\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-copy"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-copy}{}}}\r
+\subsection{Method \code{copy()}}{\r
+Copies Subcollection to a new location inside collection.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$copy(destination)}\if{html}{\out{</div>}}\r
+}\r
+\r
+\subsection{Arguments}{\r
+\if{html}{\out{<div class="arguments">}}\r
+\describe{\r
+\item{\code{destination}}{Path to copy the file.}\r
+}\r
+\if{html}{\out{</div>}}\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-duplicate"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-duplicate}{}}}\r
+\subsection{Method \code{duplicate()}}{\r
+Duplicate Subcollection and gives it a new name.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$duplicate(newName = NULL)}\if{html}{\out{</div>}}\r
+}\r
+\r
+\subsection{Arguments}{\r
+\if{html}{\out{<div class="arguments">}}\r
+\describe{\r
+\item{\code{newName}}{New name for duplicated file.}\r
+}\r
+\if{html}{\out{</div>}}\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-get"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-get}{}}}\r
+\subsection{Method \code{get()}}{\r
+If name is valid, returns ArvadosFile or Subcollection specified by relativePath, else returns NULL.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$get(name)}\if{html}{\out{</div>}}\r
+}\r
+\r
+\subsection{Arguments}{\r
+\if{html}{\out{<div class="arguments">}}\r
+\describe{\r
+\item{\code{name}}{Name of the file.}\r
+}\r
+\if{html}{\out{</div>}}\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-getFirst"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-getFirst}{}}}\r
+\subsection{Method \code{getFirst()}}{\r
+Returns files in Subcollection.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$getFirst()}\if{html}{\out{</div>}}\r
+}\r
+\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-setCollection"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-setCollection}{}}}\r
+\subsection{Method \code{setCollection()}}{\r
+Sets Collection by its UUID.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$setCollection(collection, setRecursively = TRUE)}\if{html}{\out{</div>}}\r
+}\r
+\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-getCollection"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-getCollection}{}}}\r
+\subsection{Method \code{getCollection()}}{\r
+Returns Collection of Subcollection.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$getCollection()}\if{html}{\out{</div>}}\r
+}\r
+\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-getParent"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-getParent}{}}}\r
+\subsection{Method \code{getParent()}}{\r
+Returns Collection UUID.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$getParent()}\if{html}{\out{</div>}}\r
+}\r
+\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-Subcollection-setParent"></a>}}\r
+\if{latex}{\out{\hypertarget{method-Subcollection-setParent}{}}}\r
+\subsection{Method \code{setParent()}}{\r
+Sets new Collection.\r
+\subsection{Usage}{\r
+\if{html}{\out{<div class="r">}}\preformatted{Subcollection$setParent(newParent)}\if{html}{\out{</div>}}\r
+}\r
+\r
+}\r
+}\r
projects / arvados.git / blobdiff