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

• Subcollection$new()

• Subcollection$getName()

• Subcollection$getRelativePath()

• Subcollection$add()

• Subcollection$remove()

• Subcollection$getFileListing()

• Subcollection$getSizeInBytes()

• Subcollection$move()

• Subcollection$copy()

• Subcollection$duplicate()

• Subcollection$get()

• Subcollection$getFirst()

• Subcollection$setCollection()

• Subcollection$getCollection()

• Subcollection$getParent()

• Subcollection$setParent()

Method new()

Initialize new enviroment.

Usage

Subcollection$new(name)

Arguments

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

Method remove()

Removes ArvadosFile or Subcollection specified by name from the Subcollection.

Usage

Subcollection$remove(name)

Arguments

Method getFileListing()

Returns Subcollections file content as character vector.

Usage

Subcollection$getFileListing(fullPath = TRUE)

Arguments

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

Method copy()

Copies Subcollection to a new location inside collection.

Usage

Subcollection$copy(destination)

Arguments

Method duplicate()

Duplicate Subcollection and gives it a new name.

Usage

Subcollection$duplicate(newName = NULL)

Arguments

Method get()

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

Usage

Subcollection$get(name)

Arguments

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)