Skip to contents

Get publications

get_publications.Rd

Get publications

Usage

get_publications(
  ees_environment = NULL,
  api_version = NULL,
  search = NULL,
  page_size = 40,
  page = NULL,
  verbose = FALSE
)

Arguments

ees_environment

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

api_version

EES API version

String for filtering the publication list for publication titles and summaries containing the search string provided (strings separated by spaces are combined with OR logic).

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 all available publications

Examples

get_publications()
#>                                     id                       title
#> 1 412d8090-ab45-455a-c176-08dbf5ab522b             Apprenticeships
#> 2 9676af6b-d563-41f4-d071-08da8f468680 Pupil attendance in schools
#>                          slug
#> 1             apprenticeships
#> 2 pupil-attendance-in-schools
#>                                                                                                                                                       summary
#> 1                        Apprenticeship starts, achievements and participation. Includes breakdowns by age, sex, ethnicity, subject, provider, geography etc.
#> 2 Pupil attendance and absence data including termly national statistics and fortnightly statistics in development derived from DfE’s regular attendance data
#>                       lastPublished
#> 1 2025-07-17T08:30:11.0472385+00:00
#> 2  2025-08-07T08:30:12.805125+00:00
get_publications(search = "attendance")
#>                                     id                       title
#> 1 9676af6b-d563-41f4-d071-08da8f468680 Pupil attendance in schools
#>                          slug
#> 1 pupil-attendance-in-schools
#>                                                                                                                                                       summary
#> 1 Pupil attendance and absence data including termly national statistics and fortnightly statistics in development derived from DfE’s regular attendance data
#>                      lastPublished
#> 1 2025-08-07T08:30:12.805125+00:00