Description Usage Arguments Details Value Note See Also Examples
getfame
and putfame
read and write scalars (ti,
numeric, character
or logical
objects of length 1) and
numeric tis (Time Indexed Series) from and to Fame databases.
FAME case series and series with string or FAME "date" types can be
read by getfame
, but not written with putfame
.
fameWhats
returns information about an object in a database,
including its name, class, type, basis and observed attributes, as
well as start (a ti
Time Index) and length. If getDoc
is
TRUE
, it will also include description
and
documentation
components.
fameWhats
is a wrapper around the function fameWhat
,
which provides the same information in a lower-level form.
fameWildlist
returns a list giving the name, class, type and
frequency of the objects in the database with names that match
wildString
.
1 2 3 4 5 6 | getfame(sernames, db, connection = NULL, save = FALSE, envir = parent.frame(),
start = NULL, end = NULL, getDoc = TRUE)
putfame(serlist, db, access = "shared", update = TRUE,
checkBasisAndObserved = FALSE, envir = parent.frame())
fameWhats(db, fname, connection = NULL, getDoc = TRUE)
fameWildlist(db, wildString = "?", connection = NULL, nMax = 1000, charMode = TRUE)
|
sernames |
character vector of Fame names of series and/or scalars to retrieve. |
db |
string giving the relative or full path to the Fame database to read
or write from. If the |
connection |
created by calling |
save |
if |
envir |
for |
start |
a |
end |
a |
getDoc |
if |
serlist |
the objects to be written to the database. This can be a character
vector giving the names of the objects in the environment specified
by |
access |
string specifying the access mode to open the database in. Should
be one of |
update |
if |
checkBasisAndObserved |
if |
fname |
name of an object in a FAME database |
wildString |
string containing FAME wildcards |
nMax |
maximum number of matches to return |
charMode |
if |
Fame names vs. R names:
The R names of series may differ from their Fame names. For
getfame
, names(sernames)
holds the R names of the
retrieved series. If sernames
does not have a names
attributes, the R names will be the same as the Fame names.
Naming for putfame
is more complicated, because the series
specified by serlist
for putfame
may be univariate or
multivariate. For a multivariate series, the column names of the matrix
become the Fame names. Not having a name for each column is thus an
error.
A univariate series may be a single-column matrix. If it is, and it
has a column name, that becomes the Fame name of the series.
Otherwise, the Fame name of a univariate series is the corresponding
element of names(serlist)
. If serlist
is an actual list
of series, names(serlist)
must be of the same length. For
character vector serlist
a names attribute is optional. If
there isn't one, the Fame names will be the same as the R names.
Consistency checking when update
== TRUE
:
If there is already an existing series in the database with the same
name as one in serlist
, the Fame class, type, and frequency
are checked for consistency between the updating series and the
existing series in the database. In addition, if
checkBasisAndObserved
is TRUE
, those attributes are also
checked. Inconsistencies for any of the checked attributes between
the updating existing series will abort the update. The default value
for checkBasisAndObserved
is set to FALSE
because this
inconsistency is very common in MRA code.
getfame
returns a list of the retrieved objects. If save
is T
, the list is returned invisibly. The names of the list
are the R names described in the details. Fame scalars are returned
as strings, ti
dates, or numbers. Case series are returned as
vectors of the appropriate type, with the names attribute of each
vector set to the case numbers. If getDoc
is TRUE
(the default), retrieved objects will also have
attributes named description
and documentation
.
putfame
invisibly returns an empty string.
fameWhats
returns NULL
if it can't find fname
in
db
. Otherwise, it return a list with components
name |
name of the object in the database |
class |
'series', 'scalar', or 'formula' |
type |
'undefined', 'numeric', 'namelist', 'boolean', 'string', 'precision', or 'date' |
If the object is a date, there will also be a component
tif |
tifName for the date's frequency |
If the object is a series, there will also be components
basis |
'undefined', 'daily' or 'business' |
observed |
'undefined', 'beginning', 'ending', 'averaged', 'summed', 'annualized', 'formula', 'high', or 'low' |
length |
number of observations in the series |
start |
a ti (TimeIndex) start date for the series |
These functions use the Fame HLI and a child server
process. The function fameRunning
is called to see if the
server process is already running. If not, fameStart
starts it
and the HLI. Your .Last function should call fameStop
to shut
them down gracefully. In any given R session, once the Fame HLI has
died for any reason, it cannot be restarted. This is a Fame
limitation. On exit, getfame
always closes whatever databases
it opened, so there's no reason not to just leave the server running
as long as the R session is alive. Death of the R process kills the
server process as well.
Please note that the fameConnection
functionality is not well-tested.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | ## Not run:
mydb <- "pathToMyDatabase"
boink <- getfame("gdp.q", db = mydb) ## returns a list
gpd.q <- boink[[1]] ## or boink$gdp.q
getfame("gdp.q", db = mydb, save = TRUE) ## saves gdp.q in the current frame
## saves the series as "nominalIncome"
getfame(c(nominalIncome = "gdp.q"), db = mydb, save = TRUE)
seriesA <- tis(1:24, start = c(2002, 1), freq = 12)
seriesB <- tis(1:104, start = c(2002, 1), tif = "wmonday")
documentation(seriesB) <- paste("Line", 1:4, "of seriesB documentation")
## store them as "mser" and "wser"
putfame(c(mser = "seriesA", wser = "seriesB"), db = "myfame.db")
matrixSeries <- cbind(a = seriesA, b = seriesA + 3)
putfame(matrixSeries, db = "myfame.db") ## stores as "a" and "b" in Fame
## storing a scalar as "myscalar"
putfame(c(myscalar = 42), db = "myfame.db")
fameWildlist("myfame.db")
fameWhats("myfame.db", fname = "wser", getDoc = TRUE)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.