_pkgdown.yml

url: https://clock.r-lib.org

template:
  bootstrap: 5
  package: tidytemplate
  includes:
    in_header: |
      <script defer data-domain="clock.r-lib.org,all.tidyverse.org" src="https://plausible.io/js/plausible.js"></script>

development:
  mode: auto

reference:
- title: High Level API
  desc: This section contains the high level API for R's native date and
    date-time types (Date, POSIXct, and POSIXlt). For most clock users, these
    are the only functions you'll need.
- subtitle: Construction
  contents:
  - date_build
  - date_time_build
  - date-today
- subtitle: Manipulation
  contents:
  - date_group
  - date_count_between
  - date-and-date-time-boundary
  - date-and-date-time-rounding
  - date-and-date-time-shifting
  - date_seq
  - date_spanning_seq
  - date_weekday_factor
  - date_month_factor
  - date_leap_year
  - date-time-zone
  - date_time_info
- subtitle: Getters and setters
  contents:
  - get_year.Date
  - get_year.POSIXt
  - set_year.Date
  - set_year.POSIXt
- subtitle: Parsing and formatting
  contents:
  - date_format
  - date_parse
  - date-time-parse
- subtitle: Arithmetic
  contents:
  - Date-arithmetic
  - posixt-arithmetic
- subtitle: Conversion
  contents:
  - as_date
  - as_date_time

- title: Calendars
  desc: This section contains the overarching `calendar_*()` API that applies to
    all calendars. See the subsections for details about a specific calendar.
  contents:
  - calendar_group
  - calendar_count_between
  - calendar-boundary
  - calendar_narrow
  - calendar_widen
  - calendar_spanning_seq
  - calendar_precision
  - calendar_leap_year
  - calendar_month_factor
- subtitle: Year-month-day
  contents:
  - year_month_day
  - as_year_month_day
  - is_year_month_day
  - year_month_day_parse
  - calendar_group.clock_year_month_day
  - year-month-day-count-between
  - year-month-day-boundary
  - year-month-day-narrow
  - year-month-day-widen
  - seq.clock_year_month_day
  - add_years.clock_year_month_day
  - get_year.clock_year_month_day
  - set_year.clock_year_month_day
- subtitle: Year-month-weekday
  contents:
  - year_month_weekday
  - as_year_month_weekday
  - is_year_month_weekday
  - calendar_group.clock_year_month_weekday
  - year-month-weekday-count-between
  - year-month-weekday-boundary
  - year-month-weekday-narrow
  - year-month-weekday-widen
  - seq.clock_year_month_weekday
  - add_years.clock_year_month_weekday
  - get_year.clock_year_month_weekday
  - set_year.clock_year_month_weekday
- subtitle: Year-week-day
  contents:
  - year_week_day
  - as_year_week_day
  - is_year_week_day
  - calendar_group.clock_year_week_day
  - year-week-day-count-between
  - year-week-day-boundary
  - year-week-day-narrow
  - year-week-day-widen
  - seq.clock_year_week_day
  - add_years.clock_year_week_day
  - get_year.clock_year_week_day
  - set_year.clock_year_week_day
- subtitle: ISO-year-week-day
  contents:
  - iso_year_week_day
  - as_iso_year_week_day
  - is_iso_year_week_day
  - calendar_group.clock_iso_year_week_day
  - iso-year-week-day-count-between
  - iso-year-week-day-boundary
  - iso-year-week-day-narrow
  - iso-year-week-day-widen
  - seq.clock_iso_year_week_day
  - add_years.clock_iso_year_week_day
  - get_year.clock_iso_year_week_day
  - set_year.clock_iso_year_week_day
- subtitle: Year-quarter-day
  contents:
  - year_quarter_day
  - as_year_quarter_day
  - is_year_quarter_day
  - calendar_group.clock_year_quarter_day
  - year-quarter-day-count-between
  - year-quarter-day-boundary
  - year-quarter-day-narrow
  - year-quarter-day-widen
  - seq.clock_year_quarter_day
  - add_years.clock_year_quarter_day
  - get_year.clock_year_quarter_day
  - set_year.clock_year_quarter_day
- subtitle: Year-day
  contents:
  - year_day
  - as_year_day
  - is_year_day
  - calendar_group.clock_year_day
  - year-day-count-between
  - year-day-boundary
  - year-day-narrow
  - year-day-widen
  - seq.clock_year_day
  - add_years.clock_year_day
  - get_year.clock_year_day
  - set_year.clock_year_day

- title: Invalid dates
  contents:
  - invalid_resolve

- title: Durations
  contents:
  - duration_years
  - as_duration
  - is_duration
  - duration_cast
  - duration-rounding
  - duration_precision
  - duration_spanning_seq
  - seq.clock_duration
  - duration-arithmetic

- title: Time points
- subtitle: Manipulation
  contents:
  - time_point_cast
  - time_point_count_between
  - time-point-rounding
  - time_point_shift
  - time_point_precision
  - time_point_spanning_seq
  - seq.clock_time_point
  - add_weeks.clock_time_point
- subtitle: Sys-time
  contents:
  - as_sys_time
  - is_sys_time
  - sys-parsing
  - sys_time_info
  - sys_time_now
  - as-zoned-time-sys-time
- subtitle: Naive-time
  contents:
  - as_naive_time
  - is_naive_time
  - naive_time_parse
  - naive_time_info
  - as-zoned-time-naive-time

- title: Zoned-time
  contents:
  - as_zoned_time
  - is_zoned_time
  - zoned-parsing
  - zoned_time_now
  - zoned_time_zone
  - zoned_time_precision
  - zoned_time_info
  - format.clock_zoned_time

- title: Weekdays
  contents:
  - weekday
  - as_weekday
  - is_weekday
  - weekday_code
  - weekday_factor
  - weekday-arithmetic

- title: Locale
  contents:
  - clock_locale
  - clock_labels

- title: Codes
  contents:
  - clock-codes

- title: Developer
  contents:
  - vec_arith.clock_year_month_day

- title: Generics and methods
  desc: This section contains documentation about generics and methods that is
    already exposed elsewhere on this reference page.
  contents:
  - add_years
  - get_year
  - set_year
  - date-group
  - posixt-group
  - date-count-between
  - posixt-count-between
  - date-boundary
  - posixt-boundary
  - date-formatting
  - posixt-formatting
  - date-rounding
  - posixt-rounding
  - date-shifting
  - posixt-shifting
  - date-sequence
  - posixt-sequence
  - as-zoned-time-Date
  - as-zoned-time-posixt

- title: Reexports
  contents:
  - reexports

news:
  releases:
  - text: "Version 0.1.0"
    href: https://www.tidyverse.org/blog/2021/03/clock-0-1-0/