Get publication specific data set catalogue

Usage

get_data_catalogue(
  publication_id,
  ees_environment = NULL,
  api_version = NULL,
  page_size = NULL,
  page = NULL,
  verbose = FALSE
)

Arguments

publication_id: ID of the publication to be connected to. This is required if the endpoint is "get-data-catalogue"
ees_environment: EES ees_environment to connect to: "dev", "test", "preprod" or "prod"
api_version: EES API version
page_size: Number of results to return in a single query
page: Page number of query results to return
verbose: Run with additional contextual messaging. Logical, default = FALSE

Value

Data frame listing the data sets contained within a single publication

Examples

get_data_catalogue(example_id("publication"))
#>                                     id                              title
#> 1 55629501-e98b-0c75-adba-f95a0cfbb5e9      Persistent absence in schools
#> 2 63629501-d3ca-c471-9780-ec4cb6fdf172 Reasons for absence and attendance
#> 3 55629501-1945-0174-956c-594f21c90404 Numbers of schools submitting data
#>                                                           summary    status
#> 1                                     Persistent absence measures Published
#> 2                        Reasons for pupil attendance and absence Published
#> 3 The number of schools returning data as used in the publication Published
#>   latestVersion.version          latestVersion.published
#> 1                   1.7 2025-06-16T12:14:32.320469+00:00
#> 2                   1.7 2025-06-16T12:14:32.231017+00:00
#> 3                   1.7  2025-06-16T12:14:26.57929+00:00
#>   latestVersion.totalResults                     latestVersion.id
#> 1                       3952 7551e72a-8a66-4f0c-8887-86555bbb4fae
#> 2                    4202376 d3fa62fb-6986-45da-9e15-04b7410e4d0b
#> 3                      91356 61554809-e137-4ed7-92b0-dd9c868aa328
#>   latestVersion.timePeriods.start latestVersion.timePeriods.end
#> 1                     2025 Week 8                  2025 Week 21
#> 2                    2024 Week 37                  2025 Week 21
#> 3                    2024 Week 37                  2025 Week 21
#>        latestVersion.geographicLevels
#> 1 Local authority, National, Regional
#> 2 Local authority, National, Regional
#> 3 Local authority, National, Regional
#>                                                                latestVersion.filters
#> 1                                                                    Education phase
#> 2 Attendance reason, Attendance status, Attendance type, Education phase, Time frame
#> 3                                                        Education phase, Time frame
#>                                                               latestVersion.indicators
#> 1                                                           Persistent absence percent
#> 2 Number of sessions, Number of sessions (scaled), Percent of sessions, Reference date
#> 3                Number of schools submitting, Reference date, Total number of schools