R/data.R

#' @importFrom tibble tibble
NULL

#' Age and gender grouped data for Northern Ireland from Population 2020
#' (Health and Social Care Trusts)
#' 
#' A dataset containing Population 2020 age and gender count for each HSCT in
#' Northern Ireland.
#' 
#' @format A data frame of class "tbl" with 5 rows and 11 variables:
#' \describe{
#'   \item{hsct20_name}{Health and Social Care Trust name}
#'   \item{hsct20_code}{Health and Social Care Trust code}
#'   \item{total_population}{Total population}
#'   \item{total_female_population}{Total female population}
#'   \item{total_male_population}{Total male population}
#'   \item{younger_females}{Count of females aged under 16 years}
#'   \item{working_age_females}{Count of females aged between 16 and 65}
#'   \item{older_females}{Count of females aged over 65}
#'   \item{younger_males}{Count of males aged under 16 years}
#'   \item{working_age_males}{Count of males aged between 16 and 65}
#'   \item{older_males}{Count of males aged over 65}
#' }
#' @source \url{https://www.nisra.gov.uk/}
"age_gender_hsct20_ni"

#' Age and gender grouped data for England and Wales from 2021 Census
#' 
#' A dataset containing Census 2021 age and gender count for each LA in England and Wales
#' 
#' @format A data frame of class "tbl" with 11 rows and 11 variables:
#' \describe{
#'   \item{ltla21_code}{Local Authority code}
#'   \item{total_population}{Total population}
#'   \item{total_female_population}{Total female population}
#'   \item{total_male_population}{Total male population}
#'   \item{younger_females}{Count of females aged under 20 years}
#'   \item{working_age_females}{Count of females aged between 20 and 65}
#'   \item{older_females}{Count of females aged over 65}
#'   \item{younger_males}{Count of males aged under 20 years}
#'   \item{working_age_males}{Count of males aged between 20 and 65}
#'   \item{older_males}{Count of males aged over 65}
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"age_gender21_ltla21_ew"

#' Age and gender grouped data for Northern Ireland from 2021 Census
#' (Local Government Districts)
#' 
#' A dataset containing Census 2021 age and gender count for each Local
#' Government District in Northern Ireland.
#' 
#' @format A data frame of class "tbl" with 11 rows and 11 variables:
#' \describe{
#'   \item{ltla21_name}{Local Government District name}
#'   \item{ltla21_code}{Local Government District code}
#'   \item{total_population}{Total population}
#'   \item{total_female_population}{Total female population}
#'   \item{total_male_population}{Total male population}
#'   \item{younger_females}{Count of females aged under 20 years}
#'   \item{working_age_females}{Count of females aged between 20 and 65}
#'   \item{older_females}{Count of females aged over 65}
#'   \item{younger_males}{Count of males aged under 20 years}
#'   \item{working_age_males}{Count of males aged between 20 and 65}
#'   \item{older_males}{Count of males aged over 65}
#' }
#' @source \url{https://www.nisra.gov.uk/}
"age_gender_ltla21_ni"

#' Disability data for Northern Ireland from the 2021 Census (LGD)
#' 
#' A data LSOA containing Census 2021 disability numbers and percentages for
#' each LTLA in England and Wales.
#' 
#' @format A data frame of class "tbl":
#' \describe{
#'   \item{lgd21_code}{LGD code}
#'   \item{disability}{Disability status}
#'   \item{count}{The count of people with the disability status}
#'   \item{prop}{The percentage of people with the disability status}

#'   ...
#' }
#' @source \url{https://www.nisra.gov.uk/}
"disability21_lgd21_ni"

#' Disability data for Northern Ireland from the 2021 Census (Super Data Zones)
#'
#' A data SDZ containing Census 2021 disability numbers and percentages for
#' each SDZ in Northern Ireland.
#'
#' @format A data frame of class "tbl":
#' \describe{
#'   \item{sdz21_code}{SDZ code}
#'   \item{total_households}{Total number of households in each SDZ}
#'   \item{disability}{Disability status}
#'   \item{n}{The count of households with the disability status}
#'   \item{prop}{The percentage of households with the disability status}
#'   ...
#' }
#' @source \url{https://www.nisra.gov.uk/}
"disability21_sdz21_ni"

#' Disability data for England and Wales from the 2021 Census (Lower Super Output
#' Area)
#' 
#' A dataset containing Census 2021 disability numbers and percentages for
#' each LSOA in England and Wales.
#' 
#' @format A data frame of class "tbl":
#' \describe{
#'   \item{lsoa21_code}{LSOA code}
#'   \item{disability}{Disability status}
#'   \item{n}{The count of people with the disability status}
#'   \item{total_residents}{Total residents in LSOA}
#'   \item{prop}{The percentage of people with the disability status}

#'   ...
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"disability21_lsoa21_ew"

#' Disability data for Scotland from the 2022 Census (Data Zones)
#'
#' A data DZ containing Census 2022 disability numbers and percentages for
#' each DZ in Scotland.
#'
#' @format A data frame of class "tbl":
#' \describe{
#'   \item{dz11_code}{DZ code}
#'   \item{total_residents}{Total number of residents in each DZ}
#'   \item{disability}{Disability status}
#'   \item{n}{The count of residents with the disability status}
#'   \item{prop}{The percentage of residents with the disability status}
#'   ...
#' }
#' @source \url{https://www.nisra.gov.uk/}
"disability22_dz11_scot"

#' Ethnic group data for England and Wales from the 2021 Census (Local Authority)
#' 
#' A data sets containing Census 2021 ethnic group numbers and percentages for
#' each Lower Tier Local Authority in England and Wales.
#' 
#' @format A data frame of class "tbl" with 12578 rows and 4 variables:
#' \describe{
#'   \item{ltla21_name}{Local Authority name}
#'   \item{ltla21_code}{Local Authority code}
#'   \item{ethnic_group}{Ethnic group}
#'   \item{value}{The count or percentage of the ethnic group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"ethnicity21_ltla21"


#' Ethnic group data for Northern Ireland from the 2021 Census (Local Authority)
#' 
#' A data sets containing Census 2021 ethnic group numbers and percentages for
#' each Local Government District in Northern Ireland.
#' 
#' @format A data frame of class "tbl" with 286 rows and 4 variables:
#' \describe{
#'   \item{ltla21_name}{Local Authority name}
#'   \item{ltla21_code}{Local Authority code}
#'   \item{ethnic_group}{Ethnic group}
#'   \item{value}{The count or percentage of the ethnic group}
#'   ...
#' }
#' @source \url{https://www.nisra.gov.uk/}
"ethnicity21_ltla21_ni"

#' Ethnic group data for England and Wales from the 2021 Census (LSOA)
#' 
#' A data sets containing Census 2021 ethnic group numbers and percentages for
#' each Lower Layer Super Output Area in England and Wales.
#' 
#' @format A data frame of class "tbl" with 5 variables:
#' \describe{
#'   \item{mloa21_code}{LSOA code}
#'   \item{total_residents}{Total number of residents in the LSOA}
#'   \item{ethnic_group}{Ethnic group}
#'   \item{n}{Number of people in the ethnic group}
#'   \item{prop}{Percentage of people in the ethnic group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"ethnicity21_lsoa21"

#' Ethnic group data for England and Wales from the 2021 Census (MSOA)
#' 
#' A data sets containing Census 2021 ethnic group numbers and percentages for
#' each Middle Layer Super Output Area in England and Wales.
#' 
#' @format A data frame of class "tbl" with 43,584 rows and 5 variables:
#' \describe{
#'   \item{msoa21_code}{MSOA code}
#'   \item{total_residents}{Total number of residents in the MSOA}
#'   \item{ethnic_group}{Ethnic group}
#'   \item{n}{Number of people in the ethnic group}
#'   \item{prop}{Percentage of people in the ethnic group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"ethnicity21_msoa21"

#' Ethnic group (detailed) data for England and Wales from the 2021 Census 
#' (MSOA)
#' 
#' A data sets containing Census 2021 detailed ethnic group numbers and 
#' percentages for each Middle Layer Super Output Area in England and Wales.
#' 
#' @format A data frame of class "tbl" with 2,084,768 rows and 5 variables:
#' \describe{
#'   \item{msoa21_code}{MSOA code}
#'   \item{total_residents}{Total number of residents in the MSOA}
#'   \item{ethnic_group}{Ethnic group (detailed)}
#'   \item{n}{Number of people in the ethnic group}
#'   \item{prop}{Percentage of people in the ethnic group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"ethnicity21_detailed_msoa21"

#' Households in Lower Tier Local Authorities in England and Wales, as of 
#' Census 2021
#' 
#' A data sets containing Census 2021 population counts for each Lower Tier 
#' Local Authority in the UK. Currently only Local Authority data has been
#' released for England and Wales.
#' 
#' @format A data frame of class "tbl" with 331 rows and 3 variables:
#' \describe{
#'   \item{ltla21_name}{Local Authority name}
#'   \item{ltla21_code}{Local Authority code}
#'   \item{households}{Number of households}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"households21_ltla21"

#' Deprivation dimensions for Data Zones in Scotland
#'
#' A data set containing 2011 estimates of deprivation dimensions for Data Zones in Scotland.
#'
#' @format A data frame of class "tbl" with 34,880 rows and 5 variables:
#' \describe{
#'   \item{dz11_code}{Data Zone code}
#'   \item{total_households}{Total number of households in each DZ}
#'   \item{deprivation_dimensions}{Deprived in dimensions (0 to 4)}
#'   \item{n}{Number of households per each deprivation dimension}
#'   \item{prop}{The percentage of households with the deprivation dimension status}
#' }
#' @source \url{https://www.scotlandscensus.gov.uk/search-the-census}
"household_deprivation11_dz11"

#' Deprivation dimensions for Lower Super Output Areas in England and Wales
#'
#' A data set containing 2021 estimates of deprivation dimensions for Lower Super Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 178,360 rows and 5 variables:
#' \describe{
#'   \item{lsoa21_code}{Lower Super Output Area code}
#'   \item{total_households}{Total number of households in each LSOA}
#'   \item{deprivation_dimensions}{Deprived in dimensions (0 to 4)}
#'   \item{n}{Number of households per each deprivation dimension}
#'   \item{prop}{The percentage of households with the deprivation dimension status}
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"household_deprivation21_lsoa21"

#' Deprivation dimensions for Output Areas in England and Wales
#'
#' A data set containing 2021 estimates of deprivation dimensions for Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 944,400 rows and 5 variables:
#' \describe{
#'   \item{oa21_code}{Output Area code}
#'   \item{total_households}{Total number of households in each OA}
#'   \item{deprivation_dimensions}{Deprived in dimensions (0 to 4)}
#'   \item{n}{Number of households per each deprivation dimension}
#'   \item{prop}{The percentage of households with the deprivation dimension status}
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"household_deprivation21_oa21"

#' Deprivation dimensions for Super Data Zones in Northern Ireland
#'
#' A data set containing 2021 estimates of deprivation dimensions for Super Data Zones in Northern Ireland.
#'
#' @format A data frame of class "tbl" with 4,250 rows and 5 variables:
#' \describe{
#'   \item{sdz21_code}{Super Data Zone code}
#'   \item{total_households}{Total number of households in each SDZ}
#'   \item{deprivation_dimensions}{Deprived in dimensions (0 to 4)}
#'   \item{n}{Number of households per each deprivation dimension}
#'   \item{prop}{The percentage of households with the deprivation dimension status}
#' }
#' @source \url{https://www.nisra.gov.uk/}
"household_deprivation21_sdz21"

#' Household overcrowding statistics for Data Zones in Scotland
#'
#' A data set containing 2022 estimates of household overcrowding for Data Zones in Scotland.
#'
#' @format A data frame of class "tbl" with 27,904 rows and 5 variables:
#' \describe{
#'   \item{dz11_code}{Data Zone code}
#'   \item{total_households}{Total number of households in each DZ}
#'   \item{occupancy_rating}{Occupancy rating}
#'   \item{n}{Number of households per each occupancy rating}
#'   \item{prop}{The percentage of households with the specific occupancy rating}
#' }
#' @source \url{https://www.scotlandscensus.gov.uk/scotlands-census-2022-flexible-table-builder/}
"household_overcrowding22_dz11"

#' Household overcrowding statistics for Lower Super Output Areas in England and Wales
#'
#' A data set containing 2021 estimates of household overcrowding for Lower Super Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 178,360 rows and 5 variables:
#' \describe{
#'   \item{lsoa21_code}{Lower Super Output Area code}
#'   \item{total_households}{Total number of households in each LSOA}
#'   \item{occupancy_rating}{Occupancy rating}
#'   \item{n}{Number of households per each occupancy rating}
#'   \item{prop}{The percentage of households with the specific occupancy rating}
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"household_overcrowding21_lsoa21"

#' Household overcrowding statistics for Output Areas in England and Wales
#'
#' A data set containing 2021 estimates of household overcrowding for Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 994,440 rows and 5 variables:
#' \describe{
#'   \item{oa21_code}{Lower Super Output Area code}
#'   \item{total_households}{Total number of households in each OA}
#'   \item{occupancy_rating}{Occupancy rating}
#'   \item{n}{Number of households per each occupancy rating}
#'   \item{prop}{The percentage of households with the specific occupancy rating}
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"household_overcrowding21_oa21"

#' Household overcrowding statistics for Super Data Zones in Northern Ireland
#'
#' A data set containing 2021 estimates of household overcrowding for Super Data Zones in Northern Ireland.
#'
#' @format A data frame of class "tbl" with 4,250 rows and 5 variables:
#' \describe{
#'   \item{sdz21_code}{Super Data Zone code}
#'   \item{total_households}{Total number of households in each SDZ}
#'   \item{occupancy_rating}{Occupancy rating}
#'   \item{n}{Number of households per each occupancy rating}
#'   \item{prop}{The percentage of households with the specific occupancy rating}
#' }
#' @source \url{https://www.nisra.gov.uk/}
"household_overcrowding21_sdz21"

#' Household tenure statistics for Data Zones in Scotland
#'
#' A data set containing 2022 estimates of household tenure for Data Zones in Scotland.
#'
#' @format A data frame of class "tbl" with 55,808 rows and 5 variables:
#' \describe{
#'   \item{dz11_code}{Data Zone code}
#'   \item{total_households}{Total number of households in each DZ}
#'   \item{tenure}{Household tenure type}
#'   \item{n}{Number of households per each tenure type}
#'   \item{prop}{The percentage of households with the specific tenure type}
#' }
#' @source \url{https://www.scotlandscensus.gov.uk/scotlands-census-2022-flexible-table-builder/}
"household_tenure22_dz11"

#' Household tenure statistics for Lower Super Output Areas in England and Wales
#'
#' A data set containing 2021 estimates of household tenure for Lower Super Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 285,376 rows and 5 variables:
#' \describe{
#'   \item{lsoa21_code}{Lower Super Output Area code}
#'   \item{total_households}{Total number of households in each LSOA}
#'   \item{tenure}{Household tenure type}
#'   \item{n}{Number of households per each tenure type}
#'   \item{prop}{The percentage of households with the specific tenure type}
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"household_tenure21_lsoa21"

#' Household tenure statistics for Output Areas in England and Wales
#'
#' A data set containing 2021 estimates of household tenure for Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 1,511,040 rows and 5 variables:
#' \describe{
#'   \item{oa21_code}{Output Area code}
#'   \item{total_households}{Total number of households in each OA}
#'   \item{tenure}{Household tenure type}
#'   \item{n}{Number of households per each tenure type}
#'   \item{prop}{The percentage of households with the specific tenure type}
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"household_tenure21_oa21"

#' Household tenure statistics for Super Data Zones in Northern Ireland
#'
#' A data set containing 2021 estimates of household tenure for Super Data Zones in Northern Ireland.
#'
#' @format A data frame of class "tbl" with 9,350 rows and 5 variables:
#' \describe{
#'   \item{sdz21_code}{Super Data Zone code}
#'   \item{total_households}{Total number of households in each SDZ}
#'   \item{tenure}{Household tenure type}
#'   \item{n}{Number of households per each tenure type}
#'   \item{prop}{The percentage of households with the specific tenure type}
#' }
#' @source \url{https://www.nisra.gov.uk/}
"household_tenure21_sdz21"

#' Household type statistics for Data Zones in Scotland
#'
#' A data set containing 2022 estimates of household type for Data Zones in Scotland.
#'
#' @format A data frame of class "tbl" with 48,832 rows and 5 variables:
#' \describe{
#'   \item{dz11_code}{Data Zone code}
#'   \item{total_households}{Total number of households in each DZ}
#'   \item{type}{Household type}
#'   \item{n}{Number of households per each household type}
#'   \item{prop}{The percentage of households with the specific household type}
#' }
#' @source \url{https://www.scotlandscensus.gov.uk/scotlands-census-2022-flexible-table-builder/}
"household_type22_dz11"

#' Household type statistics for Lower Super Output Areas in England and Wales
#'
#' A data set containing 2021 estimates of household type for Lower Super Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 285,376 rows and 5 variables:
#' \describe{
#'   \item{lsoa21_code}{Lower Super Output Area code}
#'   \item{total_households}{Total number of households in each LSOA}
#'   \item{type}{Household type}
#'   \item{n}{Number of households per each household type}
#'   \item{prop}{The percentage of households with the specific household type}
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"household_type21_lsoa21"

#' Household type statistics for Output Areas in England and Wales
#'
#' A data set containing 2021 estimates of household type for Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 1,511,040 rows and 5 variables:
#' \describe{
#'   \item{oa21_code}{Output Area code}
#'   \item{total_households}{Total number of households in each OA}
#'   \item{type}{Household type}
#'   \item{n}{Number of households per each household type}
#'   \item{prop}{The percentage of households with the specific household type}
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"household_type21_oa21"

#' Household type statistics for Super Data Zones in Northern Ireland
#'
#' A data set containing 2021 estimates of household type for Super Data Zones in Northern Ireland.
#'
#' @format A data frame of class "tbl" with 5,950 rows and 5 variables:
#' \describe{
#'   \item{sdz21_code}{Super Data Zone code}
#'   \item{total_households}{Total number of households in each SDZ}
#'   \item{type}{Household type}
#'   \item{n}{Number of households per each household type}
#'   \item{prop}{The percentage of households with the specific household type}
#' }
#' @source \url{https://www.nisra.gov.uk/}
"household_type21_sdz21"

#' Scottish Health Board (2019) Population Estimates
#' 
#' A data set containing population estimates for NHS Scotland Health Boards 
#' (2019), from 1981 to 2021.
#' 
#' @format A data frame of class "tbl" with 574 rows and 3 variables:
#' \describe{
#'   \item{hb19_code}{NHS Health Board code}
#'   \item{year}{Year of population estimate}
#'   \item{total_population}{Total population for all ages}
#'   ...
#' }
#' @source \url{https://www.opendata.nhs.scot/}
"population_hb19"

#' Population estimates for LSOAs in England and Wales (mid-2017 estimates with 2011 codes)
#'
#' A data set containing mid-2017 population estimates for Lower Layer Super Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 34,753 rows and 94 variables:
#' \describe{
#'   \item{lsoa11_name}{LSOA name}
#'   \item{lsoa11_code}{LSOA code}
#'   \item{total_population}{Total number of people living in each LSOA}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population17_lsoa11"

#' Population estimates for LSOAs in England and Wales (mid-2019 estimates with 2011 codes)
#'
#' A data set containing mid-2019 population estimates for Lower Layer Super Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 34,753 rows and 94 variables:
#' \describe{
#'   \item{lsoa11_name}{LSOA name}
#'   \item{lsoa11_code}{LSOA code}
#'   \item{total_population}{Total number of people living in each LSOA}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population19_lsoa11"

#' Population estimates for Local Authority Districts (mid-2019 values with 2019 codes)
#'
#' A data set containing mid-2019 population estimates for Local Authority
#' Districts (April 2019 codes) in each devolved nation.
#'
#' @format A data frame of class "tbl" with 339 rows and 94 variables:
#' \describe{
#'   \item{ltla19_name}{LAD name}
#'   \item{ltla19_code}{LAD code}
#'   \item{total_population}{Total number of people living in each LAD}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population19_ltla19"

#' Population estimates for Local Authority Districts (mid-2019 values with 2020 codes)
#'
#' A data set containing mid-2019 population estimates for Local Authority
#' Districts (April 2020 codes) in each devolved nation.
#'
#' @format A data frame of class "tbl" with 336 rows and 94 variables:
#' \describe{
#'   \item{ltla20_name}{LAD name}
#'   \item{ltla20_code}{LAD code}
#'   \item{total_population}{Total number of people living in each LAD}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population19_ltla20"

#' Population estimates for MSOAs in England and Wales (mid-2019 estimates with 2011 codes)
#'
#' A data set containing mid-2019 population estimates for Middle Layer Super Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 7,201 rows and 94 variables:
#' \describe{
#'   \item{msoa11_name}{MSOA name}
#'   \item{msoa11_code}{MSOA code}
#'   \item{total_population}{Total number of people living in each MSOA}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population19_msoa11"

#' Population estimates for Counties and Unitary Authorities (mid-2019 values with 2019 codes)
#'
#' A data set containing mid-2019 population estimates for County and Unitary
#' Authority Districts (April 2019 codes) in each devolved nation.
#'
#' @format A data frame of class "tbl" with 173 rows and 94 variables:
#' \describe{
#'   \item{utla19_name}{County or Unitary Authority name}
#'   \item{utla19_code}{County or Unitary Authority code}
#'   \item{total_population}{Total number of people living in each area}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population19_utla19"

#' Population estimates for Counties and Unitary Authorities (mid-2019 values with 2020 codes)
#'
#' A data set containing mid-2019 population estimates for County and Unitary
#' Authority Districts (April 2020 codes) in each devolved nation.
#'
#' @format A data frame of class "tbl" with 173 rows and 94 variables:
#' \describe{
#'   \item{utla20_name}{County or Unitary Authority name}
#'   \item{utla20_code}{County or Unitary Authority code}
#'   \item{total_population}{Total number of people living in each area}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population19_utla20"


#' Population estimates for Data Zones in Scotland (2020 estimates with 2011 codes)
#'
#' A data set containing 2020 population estimates by age and sex for Data Zones in Scotland.
#'
#' @format A data frame of class "tbl" with 20,928 rows and 94 variables:
#' \describe{
#'   \item{dz11_code}{Data Zone code}
#'   \item{total_population}{Total number of people living in each DZ}
#'   \item{sex}{'Female', 'Male' or 'All'}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://www.opendata.nhs.scot/}
"population20_dz11"

#' Population estimates for LSOAs in England and Wales (mid-2020 estimates with 2011 codes)
#'
#' A data set containing mid-2020 population estimates for Lower Layer Super Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 34,753 rows and 94 variables:
#' \describe{
#'   \item{lsoa11_name}{LSOA name}
#'   \item{lsoa11_code}{LSOA code}
#'   \item{total_population}{Total number of people living in each LSOA}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population20_lsoa11"

#' Population estimates for Local Authority Districts (mid-2020 values with 2020 codes)
#'
#' A data set containing mid-2020 population estimates for Local Authority
#' Districts (April 2020 codes) in each devolved nation.
#'
#' @format A data frame of class "tbl" with 336 rows and 94 variables:
#' \describe{
#'   \item{ltla20_name}{LAD name}
#'   \item{ltla20_code}{LAD code}
#'   \item{total_population}{Total number of people living in each LAD}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population20_ltla20"

#' Population estimates for Local Authority Districts (mid-2020 values with 2021 codes)
#'
#' A data set containing mid-2020 population estimates for Local Authority
#' Districts (April 2021 codes) in each devolved nation.
#'
#' @format A data frame of class "tbl" with 331 rows and 94 variables:
#' \describe{
#'   \item{ltla21_name}{LAD name}
#'   \item{ltla21_code}{LAD code}
#'   \item{total_population}{Total number of people living in each LAD}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population20_ltla21"

#' Population estimates for MSOAs in England and Wales (mid-2020 estimates with 2011 codes)
#'
#' A data set containing mid-2020 population estimates for Middle Layer Super Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 7,201 rows and 94 variables:
#' \describe{
#'   \item{msoa11_name}{MSOA name}
#'   \item{msoa11_code}{MSOA code}
#'   \item{total_population}{Total number of people living in each MSOA}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population20_msoa11"

#' Population estimates for OAs in England and Wales (mid-2020 estimates with 2011 codes)
#'
#' A data set containing mid-2020 population estimates for Output Areas in England and Wales.
#'
#' @format A data frame of class "tbl" with 181,408 rows and 94 variables:
#' \describe{
#'   \item{oa11_name}{OA name}
#'   \item{oa11_code}{OA code}
#'   \item{total_population}{Total number of people living in each OA}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population20_oa11"

#' Population estimates for Counties and Unitary Authorities (mid-2020 values with 2020 codes)
#'
#' A data set containing mid-2020 population estimates for County and Unitary
#' Authority Districts (April 2020 codes) in each devolved nation.
#'
#' @format A data frame of class "tbl" with 172 rows and 94 variables:
#' \describe{
#'   \item{utla20_name}{County or Unitary Authority name}
#'   \item{utla20_code}{County or Unitary Authority code}
#'   \item{total_population}{Total number of people living in each area}
#'   \item{`0`:`90+`}{Number of people in each single age group}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population20_utla20"

#' Population in UK countries, as of Census 2021
#' 
#' A data sets containing Census 2021 population counts for each UK nation. 
#' Note that Scotland has not yet released its latest Census results, so this
#' is based on mid-year population estimates.
#' 
#' @format A data frame of class "tbl" with 4 rows and 3 variables:
#' \describe{
#'   \item{country_name}{Country name}
#'   \item{country_code}{Country code}
#'   \item{population}{Number of people}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population21_country21"

#' Population in UK Lower Tier Local Authorities, as of Census 2021
#' 
#' A data sets containing Census 2021 population counts for each Lower Tier 
#' Local Authority in the UK. Currently only Local Authority data has been
#' released for England and Wales.
#' 
#' @format A data frame of class "tbl" with 331 rows and 3 variables:
#' \describe{
#'   \item{ltla21_name}{Local Authority name}
#'   \item{ltla21_code}{Local Authority code}
#'   \item{population}{Number of people}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"population21_ltla21"

#' Population estimates in Scotland's Data Zones (2011 codes), as of 2021
#' 
#' @format A data frame of class "tbl" with 6,976 rows and 3 variables:
#' \describe{
#'   \item{dz11_name}{Data Zone name}
#'   \item{dz11_code}{Data Zone code}
#'   \item{total_population}{Number of people}
#'   ...
#' }
#' @source \url{https://statistics.gov.scot/}
"population21_dz11"

#' Population estimates in Scotland's Intermediate Zones (2011 codes), as of 2021
#' 
#' @format A data frame of class "tbl" with 1,279 rows and 3 variables:
#' \describe{
#'   \item{iz11_name}{Intermediate Zone name}
#'   \item{iz11_code}{Intermediate Zone code}
#'   \item{total_population}{Number of people}
#'   ...
#' }
#' @source \url{https://statistics.gov.scot/}
"population21_iz11"

#' Population estimates in Scotland's Council Areas (2021 codes), as of 2021
#' 
#' @format A data frame of class "tbl" with 32 rows and 3 variables:
#' \describe{
#'   \item{ltla21_name}{Intermediate Zone name}
#'   \item{ltla21_code}{Intermediate Zone code}
#'   \item{total_population}{Number of people}
#'   ...
#' }
#' @source \url{https://statistics.gov.scot/}
"population21_ltla21"

#' Population in England and Wales Lower Layer Super Output Areas, 2022 mid year estimates
#' 
#' @format A data frame of class "tbl" with 25,672 rows and 2 variables:
#' \describe{
#'   \item{lsoa21_code}{LSOA code}
#'   \item{n_people}{Estimated number of people in LSOA}
#'   ...
#' }
#' @source \url{https://ons.gov.uk}
"population22_lsoa21"

#' Population in Scotland Councils, 2022 mid year estimates
#' 
#' A data set containing 2022 mid year estimate population counts for each 
#' Council in Scotland by sex, age.
#' 
#' @format A data frame of class "tbl" with 32 rows and 95 variables:
#' \describe{
#'   \item{ltla19_name}{Local Authority name}
#'   \item{ltla19_code}{Local Authority code}
#'   \item{sex}{Sex}
#'   \item{all_ages}{Total number of people}
#'   \item{`0`:`90 and over`}{Number of people in each single age group}

#'   ...
#' }
#' @source \url{https://www.nrscotland.gov.uk/statistics-and-data/statistics/statistics-by-theme/population/population-estimates/mid-year-population-estimates/mid-2022#:~:text=Of%20the%2032%20council%20areas,and%20Orkney%20Islands%20with%2022%2C020)}
"population22_ltla19_scotland"

#' Proficiency in English for England and Wales from the 2021 Census (MSOA)
#' 
#' A data sets containing Census 2021 proficiency in English numbers and 
#' percentages for each Middle Layer Super Output Area in England and Wales.
#' 
#' @format A data frame of class "tbl" with 7,264 rows and 8 variables:
#' \describe{
#'   \item{msoa21_code}{MSOA code}
#'   \item{Main language is English (English or Welsh in Wales)}{Number of residents where main language is English (English or Welsh in Wales)}
#'   \item{Main language is not English (English or Welsh in Wales)}{Number of residents where main language is not English (English or Welsh in Wales)}
#'   \item{Main language is not English (English or Welsh in Wales): Can speak English very well}{Number of residents where main language is not English (English or Welsh in Wales): Can speak English very wel}
#'   \item{Main language is not English (English or Welsh in Wales): Can speak English well}{Number of residents where main language is not English (English or Welsh in Wales): Can speak English wel}
#'   \item{Main language is not English (English or Welsh in Wales): Cannot speak English well}{Number of residents where main language is not English (English or Welsh in Wales): Cannot speak English wel}
#'   \item{Main language is not English (English or Welsh in Wales): Cannot speak English}{Number of residents where main language is not English (English or Welsh in Wales): Cannot speak Englishwel}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"proficiency21_msoa21"

#' A data sets containing Census 2021 migration statistics with percentages for 
#' each Middle Super Output Area (MSOA). 
#' 
#' @format A data frame of class "tbl" with 7264 rows and 9 variables:
#' \describe{
#'   \item{msoa21_code}{MSOA code}
#'   \item{msoa21_name}{MSOA name}
#'   \item{all_usual_residents}{Number of all usual residents}
#'   \item{address_one_year_ago_is_the_same}{Number where address one year ago is the same as the address of enumeration}
#'   \item{address_one_year_ago_is_student_or_boarding}{Number where address one year ago is student term-time or boarding school address in the UK}
#'   \item{migrant_from_within_uk}{Migrant from within the UK: Number where address one year ago was in the UK}
#'   \item{migrant_from_outside_uk}{Migrant from outside the UK: Number where address one year ago was outside the UK}
#'   \item{prop_migrated_from_within_uk}{Proportion of migrants from within the UK}
#'   \item{prop_migrated_from_outside_uk}{Proportion of migrants from outside the UK}
#'   ...
#' }
#' @source \url{https://www.nomisweb.co.uk/sources/census_2021_bulk}
"migration21_msoa21"

#' Religion data for England and Wales from the 2021 Census (MSOA)
#' 
#' A data sets containing Census 2021 religion numbers and percentages for
#' each Lower Layer Super Output Area in England and Wales.
#' 
#' @format A data frame of class "tbl" with 5 variables:
#' \describe{
#'   \item{lsoa21_code}{LSOA code}
#'   \item{total_residents}{Total number of residents in the LSOA}
#'   \item{religion}{Religion}
#'   \item{n}{Number of people in the religion}
#'   \item{prop}{Percentage of people in the religion}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"religion21_lsoa21"

#' Religion data for NI from the 2021 Census (LGD)
#' 
#' A data sets containing Census 2021 religion numbers and percentages for
#' each Local Government District in Northern Ireland.
#' 
#' @format A data frame of class "tbl" with 5 variables:
#' \describe{
#'   \item{lgd21_code}{LGD code}
#'   \item{religion}{Religion}
#'   \item{count}{Number of people}
#'   \item{prop}{Percentage of people}
#'   ...
#' }
#' @source \url{https://www.nisra.gov.uk/}
"religion21_lsoa21"

#' Religion data for NI from the 2021 Census (LGD)
#' 
#' A data sets containing Census 2021 sexual orientation numbers and percentages for
#' each Local Government District in Northern Ireland.
#' 
#' @format A data frame of class "tbl" with 4 variables:
#' \describe{
#'   \item{lgd21_code}{LGD code}
#'   \item{sexual_orientation}{Sexual Orientation}
#'   \item{count}{Number of people}
#'   \item{prop}{Percentage of people}
#'   ...
#' }
#' @source \url{https://www.nisra.gov.uk/}
"sexualorientation21_lgd21_ni"

#' Religion data for England and Wales from the 2021 Census (MSOA)
#' 
#' A data sets containing Census 2021 sexual orientation numbers and percentages for
#' each MSOA in England and Wales
#' 
#' @format A data frame of class "tbl" with 4 variables:
#' \describe{
#'   \item{msoa21_code}{MSOA code}
#'   \item{sexual_orientation}{Sexual Orientation}
#'   \item{count}{Number of people}
#'   \item{prop}{Percentage of people}
#'   ...
#' }
#' @source \url{https://ons.gov.uk/}
"sexualorientation21_msoa21_ew"
humaniverse/demographr documentation built on June 10, 2025, 5:39 p.m.