Get publication specific data set catalogue
get_data_catalogue.RdGet 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
Examples
get_data_catalogue(example_id("publication"))
#> id title
#> 1 3bb59201-0d1e-1e74-a745-8f65fe5895cf A level and equivalents results
#> 2 e1ae9201-2fff-d376-8fa3-bd3c3660d4c8 Pupil absence
#> 3 57b69201-033a-2c77-a19f-abcce2b11341 Pupil attendance sessions
#> summary status latestVersion.version latestVersion.published
#> 1 Published 2.0 2024-11-07T09:26:52.283236+00:00
#> 2 Test file Published 1.1 2024-11-07T09:26:52.283236+00:00
#> 3 Published 2.0 2024-11-07T09:26:52.283236+00:00
#> latestVersion.totalResults latestVersion.id
#> 1 16328 398c694e-22bb-4886-bc2b-234de253d1fe
#> 2 16 69e24d2c-298e-4885-ab55-37463c798643
#> 3 3723444 f76dc9d2-3988-4df7-b5d9-3989f9fd1d7c
#> latestVersion.timePeriods.start latestVersion.timePeriods.end
#> 1 2021/22 2022/23
#> 2 2021/22 2024/25
#> 3 2023 Week 37 2024 Week 26
#> latestVersion.geographicLevels
#> 1 School
#> 2 National
#> 3 Local authority, National, Regional
#> latestVersion.filters
#> 1 Establishment type group, Measure
#> 2 Type of school
#> 3 Attendance status, Attendance type, Day number, Establishment phase, Reason
#> latestVersion.indicators
#> 1 AAB or higher - Percentage, AAB or higher - Total students, Best three A levels - Grade, Best three A levels - Points, Best three A levels - Total students, Number of students retained, Number of students retained (2nd year), Points per entry, Points per entry (grade), Retained, Retained (2nd year), Retained and assessed, Total students, Total triggered students, Value added, Value added LCI, Value added UCI, Vocational students
#> 2 Number of overall absence sessions, Number of pupil enrolments, Number of sessions possible
#> 3 Session count, Session percent, Session scaled