select_year_level {when} | R Documentation |
Configure year level
Description
When the dimension is defined as a date type, using this function we can select the year level and its attributes to include in it: year and decade.
Usage
select_year_level(td, include_all, exclude_all, year, decade)
## S3 method for class 'when'
select_year_level(
td,
include_all = FALSE,
exclude_all = FALSE,
year = NULL,
decade = NULL
)
Arguments
td |
A |
include_all |
A boolean, include all fields of the level. |
exclude_all |
A boolean, exclude all fields of the level. |
year |
A boolean, include the year field. |
decade |
A boolean, include the decade field. |
Details
The include_all
and exclude_all
parameters allow us to include or exclude
all attributes, and then specifically exclude or include the ones we need.
Value
A when
object.
See Also
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()
,
set_attribute_definition_function()
,
set_day_part()
,
when()
Examples
td <- when() |>
select_year_level(decade = FALSE)