diff --git a/R/data.R b/R/data.R index db1c805..6404d0b 100644 --- a/R/data.R +++ b/R/data.R @@ -1,6 +1,6 @@ #' US monthly employment data #' -#' \code{us_employment} is a monthly `tsibble` containing US employment data from January 1939 +#' \code{us_employment} contains monthly US employment data from January 1939 #' to June 2019. Each `Series_ID` represents different sectors of the economy. #' #' @source @@ -18,7 +18,7 @@ NULL #' Percentage changes in economic variables in the USA. #' -#' \code{us_change} is a quarterly `tsibble` containing percentage changes in +#' \code{us_change} contains percentage changes in #' quarterly personal consumption expenditure, personal disposable income, #' production, savings and the unemployment rate for the US, 1970 to 2016. #' Original $ values were in chained 2012 US dollars. @@ -37,8 +37,8 @@ NULL #' US finished motor gasoline product supplied. #' -#' Weekly data beginning Week 6, 1991, ending Week 3, 2017. Units are -#' "million barrels per day". +#' Weekly data beginning Week 6, 1991, and ending Week 3, 2017. +#' Units are "million barrels per day". #' #' @name us_gasoline #' @docType data @@ -51,14 +51,12 @@ NULL #' NULL - #' Air Transport Passengers Australia #' #' Total annual air passengers (in millions) including domestic and #' international aircraft passengers of air carriers registered in Australia. #' 1970-2016. #' -#' #' @name aus_airpassengers #' @docType data #' @format Annual time series of class `tsibble`. @@ -70,12 +68,10 @@ NULL #' NULL - #' Rice production (Guinea) #' #' Total annual rice production (million metric tons) for Guinea. 1970-2011. #' -#' #' @name guinea_rice #' @docType data #' @format Annual time series of class `tsibble`. @@ -92,7 +88,6 @@ NULL #' Winning times for events at the Boston Marathon. #' 1897-2019. #' -#' #' @name boston_marathon #' @docType data #' @format Annual time series of class `tsibble`. @@ -106,13 +101,11 @@ NULL #' NULL - #' Monthly Canadian gas production #' #' Monthly Canadian gas production, billions of cubic metres, January 1960 - #' February 2005 #' -#' #' @name canadian_gas #' @docType data #' @format Monthly time series of class `tsibble`. @@ -127,12 +120,10 @@ NULL #' NULL - #' International Arrivals to Australia #' #' Quarterly international arrivals to Australia from Japan, New -#' Zealand, UK and the US. 1981Q1 - 2012Q3. -#' +#' Zealand, UK and the US. 1981Q1 - 2012Q3. #' #' @name aus_arrivals #' @docType data @@ -192,7 +183,6 @@ NULL #' NULL - #' Insurance quotations and advertising expenditure #' #' Monthly quotations and monthly television advertising expenditure for a US insurance company. @@ -212,9 +202,9 @@ NULL #' Australian accommodation data #' -#' \code{aus_accommodation} is a quarterly `tsibble` containing data on Australian tourist accommodation -#' from short-term non-residential accommodation with 15 or more rooms, 1998 Q1 - 2016 Q2. The data set -#' also contains the Australian Consumer Price Index (CPI) for the same period. +#' \code{aus_accommodation} contains quarterly data on Australian tourist accommodation +#' from short-term non-residential accommodation with 15 or more rooms, 1998 Q1 - 2016 Q2. +#' The data set also contains the Australian Consumer Price Index (CPI) for the same period. #' Takings are in millions of Australian dollars, #' Occupancy is a percentage of rooms occupied, #' CPI is an index with value 100 in 2012 Q1. @@ -234,7 +224,7 @@ NULL #' Australian women fertility rate #' -#' \code{aus_fertility} is a yearly `tsibble` with one measured variable: +#' \code{aus_fertility} contains annual data on one measured variable: #' \tabular{ll}{ #' Rate: \tab Fertility rate (per thousand women)\cr #' } @@ -260,7 +250,7 @@ NULL #' Monthly offences in NSW #' -#' \code{nsw_offences} is a monthly `tsibble` with one measured variable: +#' \code{nsw_offences} contains monthly data with one measured variable: #' \tabular{ll}{ #' Count: \tab Number of offences reported \cr #' } @@ -305,7 +295,7 @@ NULL #' Monthly short term (<1 year) visitor arrivals to Australia #' -#' \code{aus_inbound} is a monthly `tsibble` with one measured variable: +#' \code{aus_inbound} contains monthly data with one measured variable: #' \tabular{ll}{ #' Count: \tab Number of individuals arriving in Australia (in thousands) \cr #' } @@ -333,7 +323,7 @@ NULL #' Monthly short term (<1 year) resident departures in Australia #' -#' \code{aus_outbound} is a monthly `tsibble` with one measured variable: +#' \code{aus_outbound} contains monthly data with one measured variable: #' \tabular{ll}{ #' Count: \tab Number of individuals departing Australia (in thousands) \cr #' } @@ -363,7 +353,7 @@ NULL #' #' Weekly death counts and mortality rates in Australia. #' -#' \code{aus_mortality} is a weekly `tsibble` with two measured variables: +#' \code{aus_mortality} contains weekly data with two measured variables: #' \tabular{ll}{ #' \code{Deaths}: \tab Death count\cr #' \code{Mortality}: \tab Mortality rate @@ -396,7 +386,7 @@ NULL #' #' Daily page views on the OTexts website \url{https://OTexts.com/} as recorded by Google analytics. #' -#' \code{otexts_views} is a daily `tsibble` with two columns: +#' \code{otexts_views} contains daily data with two columns: #' \tabular{ll}{ #' \code{Date}: \tab Date for which the page views are recorded\cr #' \code{Pageviews}: \tab Page views on the OTexts website in thousands.\cr @@ -416,7 +406,7 @@ NULL #' #' Number of births in Australia. #' -#' \code{aus_births} is a monthly `tsibble` with one measured variable: +#' \code{aus_births} contains monthly data with one measured variable: #' \tabular{ll}{ #' \code{Births}: \tab Number of births\cr #' } @@ -446,7 +436,7 @@ NULL #' #' Net Overseas Migration (NOM) to Australia. #' -#' \code{aus_migration} is a quarterly `tsibble` with one measured variable: +#' \code{aus_migration} contains quarterly data with one measured variable: #' \tabular{ll}{ #' \code{NOM}: \tab The net gain or loss of population through immigration #' to Australia and emigration from Australia\cr @@ -481,7 +471,7 @@ NULL #' The total household expenditure for cigarette and tobacco consumption (CTC) #' in Australia. #' -#' \code{aus_tobacco} is a quarterly `tsibble` with one value: +#' \code{aus_tobacco} contains quarterly data with one measured variable: #' \tabular{ll}{ #' \code{Expenditure}: \tab The total expenditure\cr #' } @@ -515,7 +505,7 @@ NULL #' The number of employees (in thousands) in child day care services in #' New York City over the period the period from January 1990 to April 2024. #' -#' \code{ny_childcare} is a monthly `tsibble` with two columns: +#' \code{ny_childcare} contains monthly data with two columns: #' \tabular{ll}{ #' \code{Month}: \tab Year-month\cr #' \code{Count}: \tab Number of employees.\cr @@ -539,7 +529,7 @@ NULL #' #' The number of new motor vehicles sold in Australia. #' -#' \code{aus_vehicle_sales} is a monthly `tsibble` with one measured variable: +#' \code{aus_vehicle_sales} contains monthly data with one measured variable: #' \tabular{ll}{ #' \code{Count}: \tab The number of vehicles sold (in thousands)\cr #' } diff --git a/R/utils.R b/R/utils.R index 47965f0..b858ca3 100644 --- a/R/utils.R +++ b/R/utils.R @@ -53,7 +53,6 @@ invert <- function(x) { tapply(as.character(stacked$ind), stacked$values, list) } - style_grey <- function(level, ...) { crayon::style( paste0(...), diff --git a/man/aus_accommodation.Rd b/man/aus_accommodation.Rd index 32e2a1f..28251a7 100644 --- a/man/aus_accommodation.Rd +++ b/man/aus_accommodation.Rd @@ -11,9 +11,9 @@ Time series of class `tsibble` Australian Bureau of Statistics, Cat No 8635.0, Table 10, and Cat No 6401.0, Table 1. } \description{ -\code{aus_accommodation} is a quarterly `tsibble` containing data on Australian tourist accommodation -from short-term non-residential accommodation with 15 or more rooms, 1998 Q1 - 2016 Q2. The data set -also contains the Australian Consumer Price Index (CPI) for the same period. +\code{aus_accommodation} contains quarterly data on Australian tourist accommodation +from short-term non-residential accommodation with 15 or more rooms, 1998 Q1 - 2016 Q2. +The data set also contains the Australian Consumer Price Index (CPI) for the same period. Takings are in millions of Australian dollars, Occupancy is a percentage of rooms occupied, CPI is an index with value 100 in 2012 Q1. diff --git a/man/aus_arrivals.Rd b/man/aus_arrivals.Rd index 4041eeb..5c5a3c5 100644 --- a/man/aus_arrivals.Rd +++ b/man/aus_arrivals.Rd @@ -12,7 +12,7 @@ Tourism Research Australia. } \description{ Quarterly international arrivals to Australia from Japan, New -Zealand, UK and the US. 1981Q1 - 2012Q3. +Zealand, UK and the US. 1981Q1 - 2012Q3. } \examples{ diff --git a/man/aus_births.Rd b/man/aus_births.Rd index 7b00930..290d3b1 100644 --- a/man/aus_births.Rd +++ b/man/aus_births.Rd @@ -14,7 +14,7 @@ Australian Bureau of Statistics. \url{https://www.abs.gov.au/statistics/people/p Number of births in Australia. } \details{ -\code{aus_births} is a monthly `tsibble` with one measured variable: +\code{aus_births} contains monthly data with one measured variable: \tabular{ll}{ \code{Births}: \tab Number of births\cr } diff --git a/man/aus_fertility.Rd b/man/aus_fertility.Rd index 4696e3f..01033ce 100644 --- a/man/aus_fertility.Rd +++ b/man/aus_fertility.Rd @@ -11,7 +11,7 @@ Time series of class `tsibble` Australian Bureau of Statistics. \url{https://www.abs.gov.au/statistics/people/population/births-australia/2022} } \description{ -\code{aus_fertility} is a yearly `tsibble` with one measured variable: +\code{aus_fertility} contains annual data on one measured variable: \tabular{ll}{ Rate: \tab Fertility rate (per thousand women)\cr } diff --git a/man/aus_inbound.Rd b/man/aus_inbound.Rd index d957265..b979ccb 100644 --- a/man/aus_inbound.Rd +++ b/man/aus_inbound.Rd @@ -11,7 +11,7 @@ Time series of class `tsibble` Tourism Research Australia } \description{ -\code{aus_inbound} is a monthly `tsibble` with one measured variable: +\code{aus_inbound} contains monthly data with one measured variable: \tabular{ll}{ Count: \tab Number of individuals arriving in Australia (in thousands) \cr } diff --git a/man/aus_migration.Rd b/man/aus_migration.Rd index b0b10d5..30cb0f0 100644 --- a/man/aus_migration.Rd +++ b/man/aus_migration.Rd @@ -14,7 +14,7 @@ Australian Bureau of Statistics. \url{https://www.abs.gov.au/statistics/people/p Net Overseas Migration (NOM) to Australia. } \details{ -\code{aus_migration} is a quarterly `tsibble` with one measured variable: +\code{aus_migration} contains quarterly data with one measured variable: \tabular{ll}{ \code{NOM}: \tab The net gain or loss of population through immigration to Australia and emigration from Australia\cr diff --git a/man/aus_mortality.Rd b/man/aus_mortality.Rd index de0a6e4..1ec5e26 100644 --- a/man/aus_mortality.Rd +++ b/man/aus_mortality.Rd @@ -14,7 +14,7 @@ Time series of class `tsibble` Weekly death counts and mortality rates in Australia. } \details{ -\code{aus_mortality} is a weekly `tsibble` with two measured variables: +\code{aus_mortality} contains weekly data with two measured variables: \tabular{ll}{ \code{Deaths}: \tab Death count\cr \code{Mortality}: \tab Mortality rate diff --git a/man/aus_outbound.Rd b/man/aus_outbound.Rd index c09e429..833224c 100644 --- a/man/aus_outbound.Rd +++ b/man/aus_outbound.Rd @@ -11,7 +11,7 @@ Time series of class `tsibble` Tourism Research Australia } \description{ -\code{aus_outbound} is a monthly `tsibble` with one measured variable: +\code{aus_outbound} contains monthly data with one measured variable: \tabular{ll}{ Count: \tab Number of individuals departing Australia (in thousands) \cr } diff --git a/man/aus_tobacco.Rd b/man/aus_tobacco.Rd index 6db5d7d..66b3bdc 100644 --- a/man/aus_tobacco.Rd +++ b/man/aus_tobacco.Rd @@ -15,7 +15,7 @@ The total household expenditure for cigarette and tobacco consumption (CTC) in Australia. } \details{ -\code{aus_tobacco} is a quarterly `tsibble` with one value: +\code{aus_tobacco} contains quarterly data with one measured variable: \tabular{ll}{ \code{Expenditure}: \tab The total expenditure\cr } diff --git a/man/aus_vehicle_sales.Rd b/man/aus_vehicle_sales.Rd index 8268f9e..e5f9c2c 100644 --- a/man/aus_vehicle_sales.Rd +++ b/man/aus_vehicle_sales.Rd @@ -14,7 +14,7 @@ Australian Bureau of Statistics. \url{https://www.abs.gov.au/statistics/industry The number of new motor vehicles sold in Australia. } \details{ -\code{aus_vehicle_sales} is a monthly `tsibble` with one measured variable: +\code{aus_vehicle_sales} contains monthly data with one measured variable: \tabular{ll}{ \code{Count}: \tab The number of vehicles sold (in thousands)\cr } diff --git a/man/nsw_offences.Rd b/man/nsw_offences.Rd index fa4d80b..2e7eaf4 100644 --- a/man/nsw_offences.Rd +++ b/man/nsw_offences.Rd @@ -11,7 +11,7 @@ Time series of class `tsibble` NSW Bureau of Crime Statistics and Research. \url{https://www.bocsar.nsw.gov.au/Pages/bocsar_datasets/Offence.aspx} } \description{ -\code{nsw_offences} is a monthly `tsibble` with one measured variable: +\code{nsw_offences} contains monthly data with one measured variable: \tabular{ll}{ Count: \tab Number of offences reported \cr } diff --git a/man/ny_childcare.Rd b/man/ny_childcare.Rd index 77bb471..94d371b 100644 --- a/man/ny_childcare.Rd +++ b/man/ny_childcare.Rd @@ -18,7 +18,7 @@ The number of employees (in thousands) in child day care services in New York City over the period the period from January 1990 to April 2024. } \details{ -\code{ny_childcare} is a monthly `tsibble` with two columns: +\code{ny_childcare} contains monthly data with two columns: \tabular{ll}{ \code{Month}: \tab Year-month\cr \code{Count}: \tab Number of employees.\cr diff --git a/man/otexts_views.Rd b/man/otexts_views.Rd index c3c1981..450dd81 100644 --- a/man/otexts_views.Rd +++ b/man/otexts_views.Rd @@ -11,7 +11,7 @@ Time series of class `tsibble` Daily page views on the OTexts website \url{https://OTexts.com/} as recorded by Google analytics. } \details{ -\code{otexts_views} is a daily `tsibble` with two columns: +\code{otexts_views} contains daily data with two columns: \tabular{ll}{ \code{Date}: \tab Date for which the page views are recorded\cr \code{Pageviews}: \tab Page views on the OTexts website in thousands.\cr diff --git a/man/us_change.Rd b/man/us_change.Rd index fc876fc..97e7202 100644 --- a/man/us_change.Rd +++ b/man/us_change.Rd @@ -11,7 +11,7 @@ Time series of class `tsibble` Federal Reserve Bank of St Louis. } \description{ -\code{us_change} is a quarterly `tsibble` containing percentage changes in +\code{us_change} contains percentage changes in quarterly personal consumption expenditure, personal disposable income, production, savings and the unemployment rate for the US, 1970 to 2016. Original $ values were in chained 2012 US dollars. diff --git a/man/us_employment.Rd b/man/us_employment.Rd index d80367f..5419a12 100644 --- a/man/us_employment.Rd +++ b/man/us_employment.Rd @@ -11,7 +11,7 @@ Time series of class `tsibble` U.S. Bureau of Labor Statistics } \description{ -\code{us_employment} is a monthly `tsibble` containing US employment data from January 1939 +\code{us_employment} contains monthly US employment data from January 1939 to June 2019. Each `Series_ID` represents different sectors of the economy. } \examples{ diff --git a/man/us_gasoline.Rd b/man/us_gasoline.Rd index 3799ba9..334995a 100644 --- a/man/us_gasoline.Rd +++ b/man/us_gasoline.Rd @@ -11,8 +11,8 @@ Time series object of class `tsibble`. US Energy Information Administration. } \description{ -Weekly data beginning Week 6, 1991, ending Week 3, 2017. Units are -"million barrels per day". +Weekly data beginning Week 6, 1991, and ending Week 3, 2017. +Units are "million barrels per day". } \examples{