make_skeleton: make_skeleton

View source: R/skeleton.R

make_skeletonR Documentation

make_skeleton

Description

The easiest way to make structural data skeletons.

Usage

make_skeleton(
  date_min = NULL,
  date_max = NULL,
  isoyearweek_min = NULL,
  isoyearweek_max = NULL,
  isoyear_min = NULL,
  isoyear_max = NULL,
  calyear_min = NULL,
  calyear_max = NULL,
  time_total = FALSE,
  location_code = NULL,
  granularity_geo = "all",
  location_reference = fhidata::norway_locations_names(),
  ...
)

Arguments

date_min

The minimum date for the skeleton

date_max

The maximum date for the skeleton

isoyearweek_min

The minimum isoyearweek for the skeleton

isoyearweek_max

The maximum isoyearweek for the skeleton

isoyear_min

The minimum isoyear for the skeleton

isoyear_max

The maximum isoyear for the skeleton

calyear_min

The minimum calyear for the skeleton

calyear_max

The maximum calyear for the skeleton

time_total

Producing a 'total' time for the skeleton

location_code

The location_code's wanted for the skeleton

granularity_geo

The granularity_geo's wanted for the skeleton. If this is a list, then the returned value will also be in a list (see examples).

location_reference

A data.table that contains two columns: location_code and granularity_geo

...

Other variables to include in the skeleton

Examples

make_skeleton(date_min="2020-01-01", date_max="2020-01-30", granularity_geo = c("nation", "county"))[]
make_skeleton(isoyearweek_min="2020-01", isoyearweek_max="2020-15", granularity_geo = c("nation", "county"))[]
make_skeleton(isoyear_min="2019", isoyear_max="2021", granularity_geo = c("nation", "county"))[]
make_skeleton(calyear_min="2019", calyear_max="2021", granularity_geo = c("nation", "county"))[]
make_skeleton(time_total = TRUE, granularity_geo = c("nation", "wardoslo"))[]
make_skeleton(time_total = TRUE, granularity_geo = list(c("wardoslo", "missingwardoslo"), c("county", "missingcounty", "notmainlandcounty"), "nation"))[]
make_skeleton(time_total = TRUE, granularity_geo = list("firstbatch" = c("wardoslo", "missingwardoslo"), c("county", "missingcounty", "notmainlandcounty"), "nation"))[]
make_skeleton(isoyearweek_min = "2020-01", isoyearweek_max = "2020-03", time_total = TRUE, granularity_geo = c("nation", "wardoslo"))[]

folkehelseinstituttet/fhidata documentation built on June 3, 2022, 2:49 p.m.