Entity class

Description

An Entity object represents an entity downloaded from the Macrobond database. TimeSeries is a special form of entity and is derived from this class.

Objects from the Class

Entity objects are created by the following methods: FetchOneEntity FetchEntities

Methods

getName

signature(object = "Entity"): Get the name of the entity. This will always be the name used in the request.

getPrimaryName

signature(object = "Entity"): Get the primary name of the entity. This can differ from the name used in the request when that name is a alias or relative reference.

getTitle

signature(series = "Entity"): Get the title of the entity.

getIsError

signature(series = "Entity"): TRUE if there was an error downloading this entity. In that case the getErrorMessage method will return an error message.

getErrorMessage

signature(series = "Entity"): Get an error message text if getIsError is TRUE.

getMetadata

signature(series = "Entity"): Get a Metadata object for this entity.

show

signature(object = "Entity"): Show a summary of the entity.

See Also

TimeSeries, FetchOneEntity, FetchEntities

Examples

usRelease <- FetchOneEntity("rel_usbeana")
show(usRelease)