Get data from series for a specific operation given a filter

Usage

get_data_series_filter(
  operation = NULL,
  filter = NULL,
  periodicity = NULL,
  nlast = 1,
  dateStart = NULL,
  dateEnd = NULL,
  det = 0,
  tip = NULL,
  lang = "ES",
  page = 1,
  validate = TRUE,
  verbose = FALSE,
  unnest = FALSE
)

Arguments

operation

(string): Code of the operation. To obtain a list of available operations see get_metadata_operations().

filter

(list): list of variables and values.

Filtering data from series

When we request data from series there is the possibility of filtering data on the fly using metadata information about the variables and their values that define the series. To get variables for a given operation see get_metadata_variables() and to get values for a specific variable see get_metadata_values(). See also get_metadata_series_varval() to get all the values at once.

Filter format

The format is list(id_variable1 = id_value1, id_variable2 = id_value2). Besides:

A variable can take more than one value: list(id_variable1 = c(id_value11, id_value12), id_variable2 = id_value2).
A variable can take a empty character "" to get all its possible values: list(id_variable1 = id_value1, id_variable2 = "").

Using shortcuts

Additionally, shortcuts can be used to filter. They simplify the filtering approach by using standardized names for variable IDs and therefore simplify their use. The format is: list(shortcut_variable1 = name1, shortcut_variable2 = name2). Besides, the values wrapper can also be used: list(values = c(name1, name2). To see a list of all available shortcuts, see get_filter_shortcuts() function. Let’s also remark that for better performance is recommended to use numeric codes.

periodicity

(int): id of the periodicity of the series. Common periodicities: 1 (monthly), 3 (quarterly), 6 (bi-annual), 12 (annual). To obtain a list of periodicities see get_metadata_periodicity().

nlast

(int): number of periods to retrieve. By default is set to 1 period.

dateStart

(string): the initial date of the requested data. The required format is yyyy/mm/dd. Additionally, dateStart can be a vector of dates, where each date represents the start date of individual ranges where the end date should be found at the same position in the dateEnd vector. If dateStart and dateEnd are equal, the specified dates are retrieved. If no end date is entered, all dates will be queried, from the corresponding start date to the last available period.

dateEnd

(string): the end date of the requested data. The required format is yyyy/mm/dd. Additionally, dateEnd can be a vector of dates, where each date represents the end date of individual ranges where the initial date should be found at the same position in the dateStart vector. The length of the dateEnd vector must be less than or equal to the length of the dateStart vector.

det

(int): level of detail. Valid values: 0, 1 or 2.

tip

(string): set to 'A' for friendly output (e.g. readable dates), set to 'M' to include metadata or set to 'AM' for both.

lang

(string): language of the retrieved data. Set to 'ES' for Spanish or set to 'EN' for English.

page

(int): page number. The retrieved result of the query is paginated. Default value is set to 1.

validate

(logical): validate the input parameters. A FALSE value means fewer API calls. Therefore, it is recommended to set it to FALSE when there is no doubt about the validity of the input parameters, including the filter.

verbose

(logical): print additional information, including the URL to call the API service.

unnest

(logical): obtain a single data frame of data

Value

Data frame with data of series according to the operation and filter specified in the function

Examples

if (FALSE) { # \dontrun{
get_data_series_filter(operation = "IPC", periodicity = 1,
                       filter = list("115"= c("29","28"), "3" = "84", "762" = ""))
get_data_series_filter(operation = "IPC", periodicity = 1, nlast = 5, unnest = TRUE,
                       filter = list("115"= "28", "3" = "84", "762" = "304092"))
} # }