File: class-fWEBDATA.Rd

package info (click to toggle)
fimport 3042.85-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 996 kB
  • sloc: makefile: 2
file content (89 lines) | stat: -rw-r--r-- 2,019 bytes parent folder | download | duplicates (2)
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
\name{class-fWEBDATA}


\docType{class}


\alias{fWEBDATA-class}


\title{Class "fWEBDATA"}


\description{ 

    The class fWEBDATA represents a download from the internet.
}


\section{Objects from the Class}{

    Objects can be created by calls of the import or series
    functions.
    
}


\section{Slots}{
    \describe{
    
    \item{\code{call}:}{Object of class \code{"call"}: 
        the call of the applied function.
        } 
    \item{\code{data}:}{Object of class \code{"data.frame"}:
        the data as downloaded formatted as a data.frame.
        }
    \item{\code{param}:}{Object of class \code{"character"}:
        a character vector whose elements contain the values of selected 
        parameters of the argument list.
        }
    \item{\code{title}:}{Object of class \code{"character"}:
        a character string with the name of the download. This can be 
        overwritten specifying a user defined input argument.
        }
    \item{\code{description}:}{Object of class \code{" character"}:
        a character string with an optional user defined description. 
        By default just the current date and user when the test was 
        applied will be returned.}  
        
    }
    
}       


\section{Methods}{
    \describe{
    
    \item{show}{\code{signature(object = "fWEBDATA")}: 
        prints an object of class 'fWEBDATA'. 
        }
        
    }
}


\note{


    The import and series functions like \code{\link{fredImport}} and
    \code{\link{fredSeries}} are typical examples which show how to
    implement download functions as simple \code{timeSeries} objectx
    or as more complicate \code{fWEBDATA} S4 objects. Inspect the 
    R code and feel free to create your own download functions and
    objects.

}


\references{

    Diethelm Wuertz, Yohan Chalabi, and Andrew Ellis, (2010);
    \emph{Financial Market Data for R/Rmetrics}, 
    Rmetrics eBook, Rmetrics Association and Finance Online, Zurich,
    www.rmetrics.org.
    
}


\keyword{data}