% 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")
}
}