csodata quick start guide

Introduction

This guide provides a basic overview of the use of the csodata package for new users. Install (if necessary) and load the package:

# # Install or update the package:
# install.packages("csodata")

library(csodata)

Table of Contents

A list of all the table available on the cso StatBank can be downloaded with cso_get_toc. You can search through the title field using cso_search_toc. (A “Loaded cached toc” or “Loaded cached data” message indicates that the data was retrieved from the cache, instead of being downloaded again.)

toc <- cso_get_toc()
head(toc)
#>          LastModified
#> 1 2024-12-02 11:00:00
#> 2 2024-12-02 11:00:00
#> 3 2024-12-02 11:00:00
#> 4 2024-12-02 11:00:00
#> 5 2024-12-02 11:00:00
#> 6 2024-12-02 11:00:00
#>                                                                                                                                                                                                     title
#> 1                                                                                                         SDG 4.1.1 Second Class Pupils Performing at each Proficiency Level on the Overall Reading Scale
#> 2                                                                                           SDG 4.1.1 Sixth Class Pupils Achieving at each Proficiency Level on the Overall Mathematics Scale, NAMER 2021
#> 3                                                                                                      SDG 4.1.1 Sixth Class Pupils Performing at each Proficiency Level on the Overall Mathematics Scale
#> 4                                                                                             SDG 4.1.1 Mean PIRLS Achievement and Cumulative Percentages of Pupils Reaching the International Benchmarks
#> 5 SDG 4.1.1  Mean Scores, Standard Deviations (SD) and Standard Errors (SE) for some Countries significantly above the OECD Average, the OECD Average and the EU Average on the Overall Mathematics Scale
#> 6                                                                    SDG 4.1.1 Percentage of 15 Year Old Students Below Proficiency Level 2 and At Or Above Proficiency Level 5 on Mathematics in Ireland
#>      id
#> 1 G0402
#> 2 G0403
#> 3 G0404
#> 4 G0405
#> 5 G0407
#> 6 G0408

Downloading Data

To download a dataset, use cso_get_data and include a table code from the table of contents.

tbl1 <- cso_get_data("PEA19")

Metadata can be also downloaded or displayed to console:

meta1 <- cso_get_meta("CDP06")
cso_disp_meta("CDP06")
#> *** METADATA ***
#> CSO Table = Annual Estimated Net Migration 1951 to 2011 per 1,000 of Average Population
#> Units = Number
#> Copyright = Central Statistics Office, Ireland
#> Time interval in data = Intercensal Period
#> Are these statistics experimental? -FALSE
#> Date last modified = 2020-10-30T11:00:00.000Z
#> Variables:
#> [1] "Intercensal Period" "Province or County" "Year"
#> 
#> Statistics:
#> [1] "Annual Estimated Net Migration 1951 to 2011 per 1,000 of Average Population"
#> 
#> Geographic Data:
#> [1] FALSE

Geographic Data

Geographic vector data in ESRI shapefile format can be downloaded for use in mapping. This is a map of county councils and other local authorities in Ireland, there are many other maps available.

shp <- cso_get_geo("County Councils")
#> Warning in cso_get_geo("County Councils"): There is an issue with the county
#> cork geometry. This is being investigated.
#> Reading layer `2019_Local_Authorities' from data source 
#>   `/tmp/Rtmpqx4nVc/2019_Local_Authorities.shp' using driver `GeoJSON'
#> Simple feature collection with 31 features and 2 fields
#> Geometry type: MULTIPOLYGON
#> Dimension:     XY
#> Bounding box:  xmin: -10.68088 ymin: 51.41991 xmax: -5.996287 ymax: 55.44662
#> Geodetic CRS:  WGS 84

This data can be plotted using the leaflet package. Here we plot the outline of each region.

# install.packages("leaflet")
library(leaflet)


leaflet(shp) %>% 
  addTiles() %>% 
  addPolygons()

The data which has been cached locally can be manually cleared once we are done with it.

cso_clear_cache()