The function tidy_seasons_meta() is meant to be a user-friendly way of getting metadata about NHL seasons.

tidy_seasons_meta(
  keep_id = FALSE,
  return_datatable = getOption("tidynhl.data.table", TRUE)
)

Arguments

keep_id

(optional) Logical indicating if the IDs of different dimensions should be returned. Default to FALSE.

return_datatable

(optional) Logical indicating whether or not a data.table should be returned. Default can be set globally with options("tidynhl.data.table").

Examples

# Allowing large outputs for the pkgdown website options(width = 1000L) # Get metadata of NHL seasons tidy_seasons_meta()
#> season_regular_start season_regular_end season_playoffs_end season_teams_nb season_games_nb season_ties season_olympics season_conferences season_divisions season_wildcards #> 1: 1917-12-19 1918-03-06 1918-03-30 4 22 TRUE FALSE FALSE FALSE FALSE #> 2: 1918-12-21 1919-02-20 1919-03-29 3 18 TRUE FALSE FALSE FALSE FALSE #> 3: 1919-12-23 1920-03-13 1920-04-01 4 24 TRUE FALSE FALSE FALSE FALSE #> 4: 1920-12-22 1921-03-07 1921-04-04 4 24 TRUE FALSE FALSE FALSE FALSE #> 5: 1921-12-17 1922-03-08 1922-03-28 4 24 TRUE FALSE FALSE FALSE FALSE #> --- #> 99: 2016-10-12 2017-04-09 2017-06-11 30 82 FALSE FALSE TRUE TRUE TRUE #> 100: 2017-10-04 2018-04-08 2018-06-07 31 82 FALSE FALSE TRUE TRUE TRUE #> 101: 2018-10-03 2019-04-06 2019-06-15 31 82 FALSE FALSE TRUE TRUE TRUE #> 102: 2019-10-02 2020-03-11 2020-09-29 31 82 FALSE FALSE TRUE TRUE TRUE #> 103: 2021-01-13 2021-05-10 2021-07-15 31 56 FALSE FALSE FALSE TRUE TRUE