FlowRepositoryR (version 1.4.0)

is.downloaded: Check if a dataset or a file proxy is downloaded

Description

Return TRUE if the argument is (fully) downloaded to the local file system, FALSE otherwise.

Usage

is.downloaded(object, ...)

Arguments

object

Object of class fileProxy or flowRepData.

...

Just a placeholder for now, no additional attributes are used at this point.

Value

TRUE if object is (fully) downloaded to a local file system, FALSE otherwise. 'Fully' is only applicable to flowRepData objects and it means that all FCS data files and all attachments of the flowRepData object are downloaded.

Details

This method checks whether the argument (either a flowRepData object or a fileProxy object) is downloaded. If a dataset (flowRepData object) is passed as an argument, then all the files in that dataset need to be downloaded in order for this method to return TRUE. The method is based on the localpath attribute of the fileProxy of the argument, or of all the file proxies associated with a dataset (if flowRepData object is used).

See Also

download

Examples

    myDataset <- flowRep.get("FR-FCM-ZZ3X")
    is.downloaded(myDataset)
    is.downloaded(fcs.files(myDataset)[[1]])