attachmentProxy-class: 'attachmentProxy': a class representing a proxy to an...

In FlowRepositoryR: FlowRepository R Interface

Description

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

Details

Objects of class attachmentProxy are used to hold information about a FlowRepository attachment file. This information includes the file name, URL, size in bytes, MD5 sum, description and a path to the file on the local file system. A NULL value in the localpath slot indicates that the attachment file has not been downloaded, you can use the download method to download the file.

Creating Objects

Objects of the attachmentProxy class are created automatically when you create a flowRepData object from FlowRepository by calling the flowRep.get. A list of attachmentProxy objects will be placed in the attachments slot of the flowRepData object.

Unless you know what you are doing, creating objects using new or the constructor (as described below) is discouraged.

Objects can be created using
new("attachmentProxy",
name = ...., Object of class character
url = ...., Object of class character
size = ...., Object of class numeric
md5sum = ...., Object of class character or NULL
description = ...., Object of class character or NULL
localpath = ...., Object of class character or NULL
)

or the constructor attachmentProxy, with mandatory arguments name and url and optional arguments size, md5sum, description and localpath.

attachmentProxy(name, url, size=0, md5sum=NULL,
description=NULL, localpath=NULL)

Slots

name:

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

url:

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

size:

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

md5sum:

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

description:

Object of class character or NULL containing the description of the FlowRepository attachment file.

localpath:

Object of class character or NULL containing the path the FlowRepository attachment 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 attachment file has not been downloaded. The download method can be used to download the file.

Extends

Class fileProxy, directly.

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 an attachmentProxy. See summary for details. Usage: summary(attachmentProxy)

download

Download the referenced attachment file to the local file system, fill out the localpath slot and return an updated copy of the attachmentProxy object. See download for details. Usage: download(attachmentProxy, 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(attachmentProxy)

Author(s)

Josef Spidlen

See Also

fileProxy, fcsProxy, flowRepData, download

Examples

    myDataset <- flowRep.get("FR-FCM-ZZ3X")
    summary(attachments(myDataset)[[1]])
    str(attachments(myDataset)[[1]])

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