Subcollection | R Documentation |
Subcollection class represents a folder inside Arvados collection. It is essentially a composite of arvadosFiles and other subcollections.
new()
Initialize new enviroment.
Subcollection$new(name)
name
Name of the new enviroment.
A new 'Subcollection' object.
getName()
Returns name of the file.
Subcollection$getName()
getRelativePath()
Returns Subcollection's path relative to the root.
Subcollection$getRelativePath()
add()
Adds ArvadosFile or Subcollection specified by content to the Subcollection.
Subcollection$add(content)
content
Content to be added.
remove()
Removes ArvadosFile or Subcollection specified by name from the Subcollection.
Subcollection$remove(name)
name
Name of the file to be removed.
getFileListing()
Returns Subcollections file content as character vector.
Subcollection$getFileListing(fullPath = TRUE)
fullPath
Checking if the path to file exists.
getSizeInBytes()
Returns subcollections content size in bytes.
Subcollection$getSizeInBytes()
move()
Moves Subcollection to a new location inside collection.
Subcollection$move(destination)
destination
Path to move the file.
copy()
Copies Subcollection to a new location inside collection.
Subcollection$copy(destination)
destination
Path to copy the file.
duplicate()
Duplicate Subcollection and gives it a new name.
Subcollection$duplicate(newName = NULL)
newName
New name for duplicated file.
get()
If name is valid, returns ArvadosFile or Subcollection specified by relativePath, else returns NULL.
Subcollection$get(name)
name
Name of the file.
getFirst()
Returns files in Subcollection.
Subcollection$getFirst()
setCollection()
Sets Collection by its UUID.
Subcollection$setCollection(collection, setRecursively = TRUE)
getCollection()
Returns Collection of Subcollection.
Subcollection$getCollection()
getParent()
Returns Collection UUID.
Subcollection$getParent()
setParent()
Sets new Collection.
Subcollection$setParent(newParent)