traumar (version 1.1.0)

weekend: Classify Dates as Weekday or Weekend

Description

This function classifies each date in a vector of dates as either "Weekday" or "Weekend". The function returns "Weekday" for Monday to Friday and "Weekend" for Saturday and Sunday.

Usage

weekend(input_date)

Value

A character vector with the classification for each date: either "Weekday" or "Weekend".

Arguments

input_date

A vector of Date or POSIXct objects to classify.

Author

Nicolas Foss, Ed.D., MS

Details

The function checks if the input_date is a valid Date or POSIXct object. It returns "Weekday" for dates that fall on Monday through Friday and "Weekend" for dates that fall on Saturday or Sunday. If the input is not of the correct class, the function will throw an error.

Examples

# Example 1: Date of a weekend
weekend(as.Date("2025-01-18"))

# Example 2: Date of a weekday
weekend(as.Date("2025-01-15"))

# Example 3: Date of an invalid object
try(
weekend("2025-01-18") # This will throw an error
)