fileProxy-class: 'fileProxy': a class representing a proxy to a file in...

In FlowRepositoryR: FlowRepository R Interface

Description

This class represents basic metadata (i.e., information about) a single file in FlowRepository.

Details

Objects of class fileProxy are used to hold information about a FlowRepository file. This is a common parent class for fcsProxy and attachmentProxy classes, which hold information about an FCS file and about an attachment, respectively. Direct instances of the fileProxy are not expected.

Creating Objects

The fileProxy class is used as a common parent for fcsProxy and attachmentProxy classes. Objects of the fileProxy class shall not be created directly, unless you know exactly what you are doing.

There is no constructor defined, but objects can be created using
new("fileProxy",
name = ...., Object of class character
url = ...., Object of class character
size = ...., Object of class numeric
md5sum = ...., Object of class character or NULL
localpath = ...., Object of class character or NULL
)

Slots

name:

Object of class character containing the name of the FlowRepository file.

url:

Object of class character containing the url of the FlowRepository file.

size:

Object of class numeric containing the size of the FlowRepository file in bytes.

md5sum:

Object of class character or NULL containing the MD5 sum of the FlowRepository file.

localpath:

Object of class character or NULL containing the path the FlowRepository file as saved on the local file system. This slot is used to determine whether the file has been downloaded to the local file system. A value of NULL indicates that the file has not been downloaded.

Methods

There are separate documentation pages for some of the methods listed here which may be consulted for more details.

summary

Print a basic summary about a fileProxy. See summary for details. Usage: summary(fileProxy)

download

Download the referenced file to the local file system, fill out the localpath slot and return an updated copy of the fileProxy object. See download for details. Usage: download(fileProxy, dirpath=NULL, filepath=NULL,
curlHandle=getCurlHandle(cookiefile=""), )
show.progress=TRUE, ...)

is.downloaded

Return TRUE if the localpath slot is not NULL, which indicates that the file has been downloaded to the local file system. Return FALSE if the localpath is NULL. See is.downloaded for details. Usage: is.downloaded(fileProxy)

localpath

Return and object of class character or NULL containing the path the FlowRepository file as saved on the local file system. This slot is used to determine whether the file has been downloaded to the local file system. A value of NULL indicates that the file has not been downloaded.

Author(s)

Josef Spidlen

See Also

fcsProxy, attachmentProxy

Examples

    ## Obtain dataset information from FlowRepository
    myDataset <- flowRep.get("FR-FCM-ZZZG")
    is(fcs.files(myDataset)[[1]], "fileProxy")
    ## It should be as fcsProxy is a fileProxy
    is(attachments(myDataset)[[1]], "fileProxy")
    ## It should be as attachmentProxy is a fileProxy

FlowRepositoryR documentation built on Nov. 8, 2020, 7:26 p.m.