File-class: FileList Class

In tengfei/rabix.R: R utilities for rabix.

Description

FileList Class

File Class

Usage

FileList(...)

Arguments

...	element or list of the element.

Value

File class generator

Fields

class

(character) Must be File to indicate this object describes a file.

path

(character) The path to the file.

checksum

[character] Optional hash code for validating file integrity. Currently must be in the form "sha1$ + hexidecimal string" using the SHA-1 algorithm.

size

[numeric] Optional file size.

secondaryFile

[FileList] A list of additional files that are associated with the primary file and must be transferred alongside the primary file. Examples include indexes of the primary file, or external references which must be included when loading primary document. A file object listed in secondaryFiles may itself include secondaryFiles for which the same rules apply.

Examples

library(jsonlite)
library(yaml)
f1 <- File()
f2 <- File(path = "./out.bam", checksum = "test",
           size = 3L, secondaryFile = FileList(File(path = "./out.bai")))
fl <- FileList(f1, f2)
asList(fl)
writeLines(asYAML(fl))
asJSON(fl)
f1
f2
fl

tengfei/rabix.R documentation built on May 31, 2019, 8:34 a.m.