RWebServices (version 1.36.0)

FileReferences: FileReferences constructor and accessors

Description

Functions for creating and manipulating FileRefences-class objects.

Usage

FileReferences(urls = character(), localNames = basename(urls), types = character(length(urls)), ...)
urls(object, ...)
localNames(object, ...)
types(object, ...)
"length"(x)

Arguments

urls

A character vector of urls of the files to be referenced. The urls are the actual locations of the files.

localNames

A (optional) character vector of local names of the files to be references. Local names are the names used to refer to the files internally, e.g., by functions wanting to use file names as a label for data frame rows. The length of the local names argument must match that of the urls; the default is to take the file name portion of the url as the local name.

types

A (optional) character vector of length equal to that of the urls, containing the type each file represents. Type might normally come from a controlled vocabulary; the default is a length zero character string, reprsenting an unspecified type.

object

An object of class FileReferences, form which urls, local names, or types are to be extracted.

x

An object of class FileReferences, form which the length (number of file references) is to be determined.

...

Additional arguments, passed to the class initializaation method or (currently) ignored by the accessors.

Value

FileReferences

Object of class FileReferences.

urls, localNames, types

character vector of urls, local names, or file types.

length

integer scalar of the number of references in the object.

See Also

FileReferences-class

Examples

obj <- FileReferences(c("/foo/bar", "/foo/baz"), type=rep("CEL", 2))
localNames(obj)
length(obj)