Specific Methods for Documenting Data

Share:

Description

See the generic function description.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
    TSmeta(x, con=getOption("TSconnection"), ...) 
    ## S4 method for signature 'character,missing'
TSmeta(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'character,ANY'
TSmeta(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'ANY,missing'
TSmeta(x, con, ...)

    TSmeta(x) <- value

    TSdescription(x, con=getOption("TSconnection"), ...) 
    ## S4 method for signature 'character,missing'
TSdescription(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'character,ANY'
TSdescription(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'ANY,missing'
TSdescription(x, con, ...)
    ## S4 method for signature 'missing,ANY'
TSdescription(x, con, serIDs, ...)
    ## S4 method for signature 'missing,missing'
TSdescription(x, serIDs, ...)
    TSdescription(x) <- value

    TSdoc(x, con=getOption("TSconnection"), ...) 
    ## S4 method for signature 'character,missing'
TSdoc(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'character,ANY'
TSdoc(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'ANY,missing'
TSdoc(x, con, ...)
    ## S4 method for signature 'missing,ANY'
TSdoc(x, con, serIDs, ...)
    ## S4 method for signature 'missing,missing'
TSdoc(x, serIDs, ...)
    TSdoc(x) <- value

    TSlabel(x, con=getOption("TSconnection"), ...) 
    ## S4 method for signature 'character,missing'
TSlabel(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'character,ANY'
TSlabel(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'ANY,missing'
TSlabel(x, con, ...)
    ## S4 method for signature 'missing,ANY'
TSlabel(x, con, serIDs, ...)
    ## S4 method for signature 'missing,missing'
TSlabel(x, serIDs, ...)
    TSlabel(x) <- value

    TSsource(x, con=getOption("TSconnection"), ...) 
    ## S4 method for signature 'character,missing'
TSsource(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'character,ANY'
TSsource(x, con=getOption("TSconnection"), ...)
    ## S4 method for signature 'ANY,missing'
TSsource(x, con, ...)
    ## S4 method for signature 'missing,ANY'
TSsource(x, con, serIDs, ...)
    ## S4 method for signature 'missing,missing'
TSsource(x, serIDs, ...)
    TSsource(x) <- value

    TSrefperiod(x)
    ## S4 method for signature '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.

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.

Value

Depends. See details.

See Also

TSget, TSput, TSexists, TSdates