when {when}

when S3 class

Description

Creates a when object.

Usage

when(
  name = NULL,
  type = NULL,
  locale = NULL,
  start = lubridate::today(),
  end = lubridate::today(),
  values = NULL,
  ...
)

Arguments

name

A string, table name.

type

A string, type of calendar (NULL, 'iso', 'epi' or 'time').

locale

A locale, to use for day and month names.

start

A string, start of the period to be included in the dimension.

end

A string, end of the period to be included in the dimension.

values

A vector of string.

...

Rest of boolean configuration parameters.

Details

Using the parameters of this function we can configure practically all the elements of the dimension. Alternatively, we can use the configuration functions to define the available options.

We discuss the parameters in each of the specific configuration functions.

Value

A when object.

See Also

generate_table, get_table

Other dimension definition: define_characteristics(), define_instances(), get_attribute_definition_function(), get_day_part(), get_week_date_range(), select_date_levels(), select_day_level(), select_month_level(), select_quarter_level(), select_semester_level(), select_time_level(), select_week_level(), select_year_level(), set_attribute_definition_function(), set_day_part()

Examples

td_1 <- when()

td_2 <- when(type = 'time')