fame (version 2.21)

fameAddAttribute: Add a FAME Attribute

Description

Adds a user-defined attribute to data items in a FAME database. Data items in a FAME database can have up to 20 user-defined attributes of each of 6 types. Before you can set an item's blah attribute, the database itself must know about the attribute. This function defines the attribute to the database, so that fameSetAttribute can set it.

Usage

fameAddAttribute(name, type = c("string", "date", "boolean",
                 "precision", "numeric", "namelist"), 
db)

Arguments

name

name of the attribute

type

one of the six predefined types. Note that FAME "precision" series are 64-bit doubles, while FAME "numeric" items are 32-bit floats.

db

string giving the relative or full path to the Fame database to read or write from. If the fameLocalPath() function is defined, it will be called on this argument to obtain a path.

Value

invisibly returns a character vector of whatever FAME wrote to standard output or standard error while attempting the assignment.

See Also

fameSetAttribute to set attributes once they've been defined.