Skip to content

README.md

Latest commit

 

History

History
148 lines (123 loc) · 5.03 KB

README.md

File metadata and controls

148 lines (123 loc) · 5.03 KB

statgl

Query and visualize data published by Statistics Greenland.

Installation

You can install the development version of statgl from GitHub with:

# install.packages("devtools")
devtools::install_github("StatisticsGreenland/statgl")

To load the package contents to the R environment, run:

library(statgl)
#> R Statistics Greenland (0.2.2.92)

Search

Use statgl_search to do a freetext search of the Greenland Statbank:

statgl_search("population jan* 1st")
#> # A tibble: 12 × 6
#>    id       title                                    type  path  score published
#>    <chr>    <chr>                                    <chr> <chr> <dbl> <chr>    
#>  1 BEXSTA   Population January 1st 1977-2024         t     /BE/… 0.344 2024-02-…
#>  2 BEXST1   Population January 1st 1977-2020         t     /BE/… 0.344 2020-02-…
#>  3 BEXSTAYY Population January 1st, fixed residence… t     /BE/… 0.292 2024-05-…
#>  4 BEXSTB   Population in Municipalities January 1s… t     /BE/… 0.292 2024-02-…
#>  5 BEXSTC   Population in Districts and Municipalit… t     /BE/… 0.292 2024-02-…
#>  6 BEXSTD   Population in Localities January 1st 19… t     /BE/… 0.292 2024-02-…
#>  7 BEXSTDt  Population seniority in Localities Janu… t     /BE/… 0.292 2024-02-…
#>  8 BEXSTNUK Population In Nuuk January 1st by cityd… t     /BE/… 0.292 2024-02-…
#>  9 BEXST2A  Population in  municipalities(2018) Jan… t     /BE/… 0.292 2017-10-…
#> 10 BEXST2   Population in Municipalities January 1s… t     /BE/… 0.292 2020-02-…
#> 11 BEXST3   Population in Districts and Municipalit… t     /BE/… 0.292 2020-02-…
#> 12 BEXST4   Population in Localities January 1st 19… t     /BE/… 0.292 2020-06-…

Fetch

The ID’s found in search results are unique table ID’s, which can be collected by statgl_fetch:

statgl_fetch("BEESTA")
#> # A tibble: 48 × 2
#>    time  value
#>    <chr> <int>
#>  1 1977  49717
#>  2 1978  49148
#>  3 1979  49338
#>  4 1980  49773
#>  5 1981  50643
#>  6 1982  51435
#>  7 1983  51903
#>  8 1984  52347
#>  9 1985  52940
#> 10 1986  53406
#> # ℹ 38 more rows

Eliminable variables are removed by default. To see which variables can be queried, use statgl_meta:

statgl_meta("BEESTA")
#> $title
#> [1] "Population January 1st by place of birth, gender, age, residence type and time"
#> 
#> $url
#> [1] "https://bank.stat.gl:443/api/v1/en/Greenland/BE/BE01/BE0120/BEXSTA.px"
#> 
#> $variables
#> # A tibble: 5 × 6
#>   code           text           elimination time  values      valueTexts 
#>   <chr>          <chr>          <lgl>       <lgl> <list>      <list>     
#> 1 age            age            TRUE        NA    <chr [100]> <chr [100]>
#> 2 gender         gender         TRUE        NA    <chr [3]>   <chr [3]>  
#> 3 place of birth place of birth TRUE        NA    <chr [3]>   <chr [3]>  
#> 4 residence type residence type TRUE        NA    <chr [8]>   <chr [8]>  
#> 5 time           time           NA          TRUE  <chr [48]>  <chr [48]>

Codes from values columns can be used to query:

statgl_fetch("BEESTA", gender = c("M", "K"), age = 0:99)
#> # A tibble: 9,600 × 4
#>    gender age   time  value
#>    <chr>  <chr> <chr> <int>
#>  1 Men    0     1977    428
#>  2 Men    0     1978    443
#>  3 Men    0     1979    410
#>  4 Men    0     1980    427
#>  5 Men    0     1981    507
#>  6 Men    0     1982    510
#>  7 Men    0     1983    529
#>  8 Men    0     1984    494
#>  9 Men    0     1985    519
#> 10 Men    0     1986    564
#> # ℹ 9,590 more rows

Use .eliminate_rest = FALSE to show all values of remaining eliminables:

statgl_fetch("BEXSTA", .eliminate_rest = FALSE)
#> # A tibble: 345,600 × 6
#>    `place of birth` gender age   `residence type` time  value
#>    <chr>            <chr>  <chr> <chr>            <chr> <int>
#>  1 Total            Total  0     Total            1977    820
#>  2 Total            Total  0     Total            1978    834
#>  3 Total            Total  0     Total            1979    816
#>  4 Total            Total  0     Total            1980    861
#>  5 Total            Total  0     Total            1981    970
#>  6 Total            Total  0     Total            1982   1016
#>  7 Total            Total  0     Total            1983   1020
#>  8 Total            Total  0     Total            1984    946
#>  9 Total            Total  0     Total            1985    996
#> 10 Total            Total  0     Total            1986   1115
#> # ℹ 345,590 more rows

ggplot

The package comes with extensions for ggplot2, to create data visualizations following the Statistics Greenland design manual:

library(ggplot2)

ggplot(statgl_fetch("BEESTA", gender = c("M", "K"))) +
  geom_line(aes(as.numeric(time), value, color = gender)) +
  scale_color_statgl() +
  theme_statgl()