R/docs-datasets.R

In ONSdigital/Bayesian-demographic-accounts: Bayesian Demographic Accounts

## Documentation for datasets

## 'gl_reg_popn' ------------------------------------------------------------

#' Registered population in Greenland
#'
#' Registered population in Greenland by cohort, age,
#' gender of child, and calendar year.
#'
#' @format A data frame with columns \code{"cohort"},
#' \code{"age"}, \code{"gender"},
#' \code{"time"}, and \code{"count"}.
#'
#' @source The StatsBank database on the Statistics Greenland
#' website, accessed using package 'pxweb'.
"gl_reg_popn"


## 'gl_reg_births' ------------------------------------------------------------

#' Registered births in Greenland
#'
#' Registered births in Greenland by cohort and age of mother,
#' gender of child, and calendar year.
#'
#' @format A data frame with columns \code{"cohort"},
#' \code{"age"}, \code{"gender"},
#' \code{"time"}, and \code{"count"}.
#'
#' @source The StatsBank database on the Statistics Greenland
#' website, accessed using package 'pxweb'.
"gl_reg_births"


## 'gl_reg_deaths' ------------------------------------------------------------

#' Registered deaths in Greenland
#'
#' Registered deaths in Greenland by cohort, age,
#' gender, and calendar year.
#'
#' @format A data frame with columns \code{"cohort"},
#' \code{"age"}, \code{"gender"},
#' \code{"time"}, and \code{"count"}.
#'
#' @source The StatsBank database on the Statistics Greenland
#' website, accessed using package 'pxweb'.
"gl_reg_deaths"


## 'gl_reg_immig' -------------------------------------------------------------

#' Registered immigration in Greenland
#'
#' Registered immigration to Greenland by cohort, age,
#' gender, and calendar year.
#'
#' @format A data frame with columns \code{"cohort"},
#' \code{"age"}, \code{"gender"},
#' \code{"time"}, and \code{"count"}.
#'
#' @source The StatsBank database on the Statistics Greenland
#' website, accessed using package 'pxweb'.
"gl_reg_immig"


## 'gl_reg_emig' --------------------------------------------------------------

#' Registered emigration from Greenland
#'
#' Registered emigration Greenland by cohort, age,
#' gender, and calendar year.
#'
#' @format A data frame with columns \code{"cohort"},
#' \code{"age"}, \code{"gender"},
#' \code{"time"}, and \code{"count"}.
#'
#' @source The StatsBank database on the Statistics Greenland
#' website, accessed using package 'pxweb'.
"gl_reg_emig"