weekday: Access /weekday endpoint

Description Usage Arguments Value Examples

View source: R/weekday.R

Description

This function accesses the /weekday endpoint of the Christmas Countdown API. The API returns an integer corresponding to the weekday that Christmas falls on. By default, this function returns a string representing the weekday, but an argument can be passed to specify returning the 1-based index integer instead.

Usage

1
weekday(return_index = FALSE)

Arguments

return_index

Whether to return the day as a 1-based index integer. Defaults to FALSE

Value

A string or an integer corresponding to the weekday that CHristmas falls on

Examples

1
2
weekday()
weekday(return_index = TRUE)

Sean-C-Casey/christmaswrap documentation built on Feb. 24, 2022, 12:33 a.m.