-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/Subcollection.R
-\name{Subcollection}
-\alias{Subcollection}
-\title{Subcollection}
-\description{
-Subcollection class represents a folder inside Arvados collection.
-It is essentially a composite of arvadosFiles and other subcollections.
-}
-\section{Usage}{
-
-\preformatted{subcollection = Subcollection$new(name)}
-}
-
-\section{Arguments}{
-
-\describe{
- \item{name}{Name of the subcollection.}
-}
-}
-
-\section{Methods}{
-
-\describe{
- \item{getName()}{Returns name of the subcollection.}
- \item{getRelativePath()}{Returns subcollection path relative to the root.}
- \item{add(content)}{Adds ArvadosFile or Subcollection specified by content to the subcollection.}
- \item{remove(name)}{Removes ArvadosFile or Subcollection specified by name from the subcollection.}
- \item{get(relativePath)}{If relativePath is valid, returns ArvadosFile or Subcollection specified by relativePath, else returns NULL.}
- \item{getFileListing()}{Returns subcollections file content as character vector.}
- \item{getSizeInBytes()}{Returns subcollections content size in bytes.}
- \item{move(destination)}{Moves subcollection to a new location inside collection.}
- \item{copy(destination)}{Copies subcollection to a new location inside collection.}
-}
-}
-
-\examples{
-\dontrun{
-myFolder <- Subcollection$new("myFolder")
-myFile <- ArvadosFile$new("myFile")
-
-myFolder$add(myFile)
-myFolder$get("myFile")
-myFolder$remove("myFile")
-
-myFolder$move("newLocation/myFolder")
-myFolder$copy("newLocation/myFolder")
-}
-}
+% 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-new}{\code{Subcollection$new()}}\r
+\item \href{#method-getName}{\code{Subcollection$getName()}}\r
+\item \href{#method-getRelativePath}{\code{Subcollection$getRelativePath()}}\r
+\item \href{#method-add}{\code{Subcollection$add()}}\r
+\item \href{#method-remove}{\code{Subcollection$remove()}}\r
+\item \href{#method-getFileListing}{\code{Subcollection$getFileListing()}}\r
+\item \href{#method-getSizeInBytes}{\code{Subcollection$getSizeInBytes()}}\r
+\item \href{#method-move}{\code{Subcollection$move()}}\r
+\item \href{#method-copy}{\code{Subcollection$copy()}}\r
+\item \href{#method-duplicate}{\code{Subcollection$duplicate()}}\r
+\item \href{#method-get}{\code{Subcollection$get()}}\r
+\item \href{#method-getFirst}{\code{Subcollection$getFirst()}}\r
+\item \href{#method-setCollection}{\code{Subcollection$setCollection()}}\r
+\item \href{#method-getCollection}{\code{Subcollection$getCollection()}}\r
+\item \href{#method-getParent}{\code{Subcollection$getParent()}}\r
+\item \href{#method-setParent}{\code{Subcollection$setParent()}}\r
+}\r
+}\r
+\if{html}{\out{<hr>}}\r
+\if{html}{\out{<a id="method-new"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-getName"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-getRelativePath"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-add"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-remove"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-getFileListing"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-getSizeInBytes"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-move"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-copy"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-duplicate"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-get"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-getFirst"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-setCollection"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-getCollection"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-getParent"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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-setParent"></a>}}\r
+\if{latex}{\out{\hypertarget{method-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