SubcollectionR Documentation

R6 Class Representing a Subcollection

Description

Subcollection class represents a folder inside Arvados collection. It is essentially a composite of arvadosFiles and other subcollections.

Methods

Public methods


Method new()

Initialize new enviroment.

Usage
Subcollection$new(name)
Arguments
name

Name of the new enviroment.

Returns

A new 'Subcollection' object.


Method getName()

Returns name of the file.

Usage
Subcollection$getName()

Method getRelativePath()

Returns Subcollection's path relative to the root.

Usage
Subcollection$getRelativePath()

Method add()

Adds ArvadosFile or Subcollection specified by content to the Subcollection.

Usage
Subcollection$add(content)
Arguments
content

Content to be added.


Method remove()

Removes ArvadosFile or Subcollection specified by name from the Subcollection.

Usage
Subcollection$remove(name)
Arguments
name

Name of the file to be removed.


Method getFileListing()

Returns Subcollections file content as character vector.

Usage
Subcollection$getFileListing(fullPath = TRUE)
Arguments
fullPath

Checking if the path to file exists.


Method getSizeInBytes()

Returns subcollections content size in bytes.

Usage
Subcollection$getSizeInBytes()

Method move()

Moves Subcollection to a new location inside collection.

Usage
Subcollection$move(destination)
Arguments
destination

Path to move the file.


Method copy()

Copies Subcollection to a new location inside collection.

Usage
Subcollection$copy(destination)
Arguments
destination

Path to copy the file.


Method duplicate()

Duplicate Subcollection and gives it a new name.

Usage
Subcollection$duplicate(newName = NULL)
Arguments
newName

New name for duplicated file.


Method get()

If name is valid, returns ArvadosFile or Subcollection specified by relativePath, else returns NULL.

Usage
Subcollection$get(name)
Arguments
name

Name of the file.


Method getFirst()

Returns files in Subcollection.

Usage
Subcollection$getFirst()

Method setCollection()

Sets Collection by its UUID.

Usage
Subcollection$setCollection(collection, setRecursively = TRUE)

Method getCollection()

Returns Collection of Subcollection.

Usage
Subcollection$getCollection()

Method getParent()

Returns Collection UUID.

Usage
Subcollection$getParent()

Method setParent()

Sets new Collection.

Usage
Subcollection$setParent(newParent)