R/datasets.R

In iNZightVIT/iNZight: A GUI for Data Exploration and Visualisation

#' Census at School 500
#'
#' A dataset containing 500 observations from a New Zealand census of school
#' students.
#'
#' @format A data frame with 500 rows and 10 variables:
#' \describe{
#'   \item{cellsource}{the source of cellphone money}
#'   \item{rightfoot}{length of the right foot, mm}
#'   \item{travel}{travel method used to get to school}
#'   \item{getlunch}{how they get their lunch}
#'   \item{height}{height measurement, cm}
#'   \item{gender}{their biological gender}
#'   \item{age}{their age, years}
#'   \item{year}{their school year}
#'   \item{armspan}{their armspan measurement, cm}
#'   \item{cellcost}{money spent on cellphones}
#' }
#' @source This dataset is provided *exclusively for use within iNZight* by express permission
#' from Chris Wild, the Director of Census at School New Zealand.
#'  \url{http://new.censusatschool.org.nz/}
#' @docType data
#' @md
"census.at.school.500"


#' Gap Minder
#'
#' A dataset containing variables for countries over several years.
#' You can find out more about the dataset from \url{https://www.gapminder.org/data/}.
#'
#' @source Based on free material from GAPMINDER.ORG, CC-BY LICENSE
#'  \url{https://www.gapminder.org/data/}
#' @docType data
"gapminder"


#' SURF Income Survey
#'
#' The NZIS is run annually during the June quarter (April to June),
#' as a supplement to the Household Labour Force Survey (HLFS).
#' All respondents in the HLFS were asked to participate in the NZIS,
#' which provides a snapshot of income levels for people and households.
#' NZIS data gives average weekly income for the June quarter from most sources,
#' including government transfers, investments, self-employment, and wages and salaries.
#'
#' This is a subset of that data.
#'
#' @format A data frame with 200 rows and 8 variables:
#' \describe{
#'   \item{Personid}{a random unique ID number for each record in the Super SURF}
#'   \item{Gender}{male and female}
#'   \item{Qualification}{five categories}
#'   \item{Age}{25 to 64 years in 5-year age bands}
#'   \item{Hours}{total usual weekly hours worked from all wages and salary jobs}
#'   \item{Income}{total usual weekly income from all sources}
#'   \item{Marital}{marital status}
#'   \item{Ethnicity}{six categories}
#' }
#' @source Licensed under Creative Commons 4.0 by Stats NZ,
#'  \url{https://www.stats.govt.nz/services/customised-data-services/statistics-for-university-staff-and-students/new-zealand-income-survey-super-surf/}
#' @docType data
"SURFIncomeSurvey_200"