Skip to contents

Get a parsed version of the API response for a data set's meta data

get_meta.Rd

Get a list of metadata information for a data set available from the EES API. Provides either look-up tables from human readable labels to ids used in the API, or the raw response from the meta endpoint.

Usage

get_meta(
  dataset_id,
  dataset_version = NULL,
  ees_environment = NULL,
  api_version = NULL,
  verbose = FALSE
)

Arguments

dataset_id

ID of data set to be connected to. This is required if the endpoint is one of "get-summary", "get-meta", "get-csv", "get-data" or "post-data"

dataset_version

Version of data set to be connected to

ees_environment

EES ees_environment to connect to: "dev", "test", "preprod" or "prod"

api_version

EES API version

verbose

Run with additional contextual messaging. Logical, default = FALSE

Value

List of data frames containing a data set's meta data

Examples

get_meta(example_id())
#> $time_periods
#>   code    period   label
#> 1   AY 2021/2022 2021/22
#> 2   AY 2022/2023 2022/23
#> 3   AY 2023/2024 2023/24
#> 
#> $locations
#>   item_id   label      code geographic_level_code geographic_level
#> 1   mRj9K England E92000001                   NAT         National
#> 
#> $filter_columns
#>   col_id           col_name          label
#> 1  arLPb establishment_type Type of school
#> 
#> $filter_items
#>   col_id        item_label item_id default_item
#> 1  arLPb   Primary schools   VN5XE           NA
#> 2  arLPb Secondary schools   PEebW           NA
#> 3  arLPb   Special schools   1Ti3Z           NA
#> 4  arLPb             Total   dt0Zw         TRUE
#> 
#> $indicators
#>   col_id                col_name                              label
#> 1  dPe0Z   count_absent_sessions Number of overall absence sessions
#> 2  OBXCL        count_enrolments         Number of pupil enrolments
#> 3  7YFXo count_possible_sessions        Number of sessions possible
#>