Skip to content

Commit

Permalink
Help file consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
robjhyndman committed Jun 25, 2024
1 parent a0328bb commit aa4932f
Show file tree
Hide file tree
Showing 18 changed files with 38 additions and 49 deletions.
48 changes: 19 additions & 29 deletions R/data.R
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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`.
Expand All @@ -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`.
Expand All @@ -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`.
Expand All @@ -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`.
Expand All @@ -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
Expand Down Expand Up @@ -192,7 +183,6 @@ NULL
#'
NULL


#' Insurance quotations and advertising expenditure
#'
#' Monthly quotations and monthly television advertising expenditure for a US insurance company.
Expand All @@ -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.
Expand All @@ -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
#' }
Expand All @@ -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
#' }
Expand Down Expand Up @@ -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
#' }
Expand Down Expand Up @@ -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
#' }
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
#' }
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
#' }
Expand Down Expand Up @@ -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
Expand All @@ -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
#' }
Expand Down
1 change: 0 additions & 1 deletion R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ invert <- function(x) {
tapply(as.character(stacked$ind), stacked$values, list)
}


style_grey <- function(level, ...) {
crayon::style(
paste0(...),
Expand Down
6 changes: 3 additions & 3 deletions man/aus_accommodation.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aus_arrivals.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aus_births.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aus_fertility.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aus_inbound.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aus_migration.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aus_mortality.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aus_outbound.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aus_tobacco.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/aus_vehicle_sales.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/nsw_offences.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ny_childcare.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/otexts_views.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/us_change.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/us_employment.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/us_gasoline.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit aa4932f

Please sign in to comment.