20660: Add devtools::check to run_test.R
[arvados.git] / sdk / R / man / Subcollection.Rd
index 1c9ec96e119746b059895701f719e1a8836d00b4..9faf0c279e6544e7e73870409d24366dcb7b1e24 100644 (file)
@@ -10,27 +10,27 @@ It is essentially a composite of arvadosFiles and other subcollections.
 \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
+\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
@@ -49,8 +49,8 @@ A new `Subcollection` object.
 }\r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-getName"></a>}}\r
-\if{latex}{\out{\hypertarget{method-getName}{}}}\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
@@ -59,8 +59,8 @@ Returns name of the file.
 \r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-getRelativePath"></a>}}\r
-\if{latex}{\out{\hypertarget{method-getRelativePath}{}}}\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
@@ -69,8 +69,8 @@ Returns Subcollection's path relative to the root.
 \r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-add"></a>}}\r
-\if{latex}{\out{\hypertarget{method-add}{}}}\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
@@ -86,8 +86,8 @@ Adds ArvadosFile or Subcollection specified by content to the Subcollection.
 }\r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-remove"></a>}}\r
-\if{latex}{\out{\hypertarget{method-remove}{}}}\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
@@ -103,8 +103,8 @@ Removes ArvadosFile or Subcollection specified by name from the Subcollection.
 }\r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-getFileListing"></a>}}\r
-\if{latex}{\out{\hypertarget{method-getFileListing}{}}}\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
@@ -120,8 +120,8 @@ Returns Subcollections file content as character vector.
 }\r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-getSizeInBytes"></a>}}\r
-\if{latex}{\out{\hypertarget{method-getSizeInBytes}{}}}\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
@@ -130,8 +130,8 @@ Returns subcollections content size in bytes.
 \r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-move"></a>}}\r
-\if{latex}{\out{\hypertarget{method-move}{}}}\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
@@ -147,8 +147,8 @@ Moves Subcollection to a new location inside collection.
 }\r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-copy"></a>}}\r
-\if{latex}{\out{\hypertarget{method-copy}{}}}\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
@@ -164,8 +164,8 @@ Copies Subcollection to a new location inside collection.
 }\r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-duplicate"></a>}}\r
-\if{latex}{\out{\hypertarget{method-duplicate}{}}}\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
@@ -181,8 +181,8 @@ Duplicate Subcollection and gives it a new name.
 }\r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-get"></a>}}\r
-\if{latex}{\out{\hypertarget{method-get}{}}}\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
@@ -198,8 +198,8 @@ If name is valid, returns ArvadosFile or Subcollection specified by relativePath
 }\r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-getFirst"></a>}}\r
-\if{latex}{\out{\hypertarget{method-getFirst}{}}}\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
@@ -208,8 +208,8 @@ Returns files in Subcollection.
 \r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-setCollection"></a>}}\r
-\if{latex}{\out{\hypertarget{method-setCollection}{}}}\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
@@ -218,8 +218,8 @@ Sets Collection by its UUID.
 \r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-getCollection"></a>}}\r
-\if{latex}{\out{\hypertarget{method-getCollection}{}}}\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
@@ -228,8 +228,8 @@ Returns Collection of Subcollection.
 \r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-getParent"></a>}}\r
-\if{latex}{\out{\hypertarget{method-getParent}{}}}\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
@@ -238,8 +238,8 @@ Returns Collection UUID.
 \r
 }\r
 \if{html}{\out{<hr>}}\r
-\if{html}{\out{<a id="method-setParent"></a>}}\r
-\if{latex}{\out{\hypertarget{method-setParent}{}}}\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