SearchResult-class {MacrobondAPI}R Documentation

SearchResult class

Description

This class represents the result of a search query.

Objects from the Class

Objects are created by calling Search.

Methods

getEntities

signature(object = "SearchResult"): Returned the list of entities that matched the search criteria.

getIsTruncated

signature(object = "SearchResult"): TRUE if the search resulted in too many hits and the list of entities is truncated.

See Also

Search CreateSearchQuery SearchQuery Entity

Examples

# Search for time series that are the key GDP series for the regions US, GB and DE.
query <- CreateSearchQuery()
setEntityTypeFilter(query, "TimeSeries")
addAttributeValueFilter(query, "RegionKey", "gdp_total")
addAttributeValueFilter(query, "Region", c("us", "gb", "de"))
searchResult <- Search(query)

[Package MacrobondAPI version 1.1-5 Index]