TSdbi (version 2017.4-1)

TSdescription: Specific Methods for Documenting Data

Description

See the generic function description.

Usage

TSmeta(x, con=getOption("TSconnection"), ...) 
    # S4 method for character,missing
TSmeta(x, con=getOption("TSconnection"), ...)
    # S4 method for character,ANY
TSmeta(x, con=getOption("TSconnection"), ...)
    # S4 method for ANY,missing
TSmeta(x, con, ...)
    TSmeta(x) <- value
    TSdescription(x, con=getOption("TSconnection"), ...) 
    # S4 method for character,missing
TSdescription(x, con=getOption("TSconnection"), ...)
    # S4 method for character,ANY
TSdescription(x, con=getOption("TSconnection"), ...)
    # S4 method for ANY,missing
TSdescription(x, con, ...)
    # S4 method for missing,ANY
TSdescription(x, con, serIDs, ...)
    # S4 method for missing,missing
TSdescription(x, serIDs, ...)
    TSdescription(x) <- value
    TSdoc(x, con=getOption("TSconnection"), ...) 
    # S4 method for character,missing
TSdoc(x, con=getOption("TSconnection"), ...)
    # S4 method for character,ANY
TSdoc(x, con=getOption("TSconnection"), ...)
    # S4 method for ANY,missing
TSdoc(x, con, ...)
    # S4 method for missing,ANY
TSdoc(x, con, serIDs, ...)
    # S4 method for missing,missing
TSdoc(x, serIDs, ...)
    TSdoc(x) <- value
    TSlabel(x, con=getOption("TSconnection"), ...) 
    # S4 method for character,missing
TSlabel(x, con=getOption("TSconnection"), ...)
    # S4 method for character,ANY
TSlabel(x, con=getOption("TSconnection"), ...)
    # S4 method for ANY,missing
TSlabel(x, con, ...)
    # S4 method for missing,ANY
TSlabel(x, con, serIDs, ...)
    # S4 method for missing,missing
TSlabel(x, serIDs, ...)
    TSlabel(x) <- value
    TSsource(x, con=getOption("TSconnection"), ...) 
    # S4 method for character,missing
TSsource(x, con=getOption("TSconnection"), ...)
    # S4 method for character,ANY
TSsource(x, con=getOption("TSconnection"), ...)
    # S4 method for ANY,missing
TSsource(x, con, ...)
    # S4 method for missing,ANY
TSsource(x, con, serIDs, ...)
    # S4 method for missing,missing
TSsource(x, serIDs, ...)
    TSsource(x) <- value
    TSrefperiod(x)
    # S4 method for default
TSrefperiod(x)
    TSrefperiod(x) <- value

Arguments

con

A database connection.

serIDs

identifiers for series on the database.

x

a time series data object or an identifier for a series on the database.

value

a character string (or vector of character strings).

...

arguments passed to other methods.

Value

Depends. See details.

Details

These functions return various information about the data series. Methods with con and serIDs (sometimes identifiers are passed as argument x) get data from the database. Others extract information from the object.

Assignments assign an attribute to the object x with value. If x is a multivariate time series (matrix) then value should be a vector of length equal the number of series. The reference period for a time series indicates a special refence point (e.g. "Wednesday" for weekly data collected on Wednesday).

The extraction methods extract the attribute.

See Also

TSget, TSput, TSexists, TSdates