Skip to contents

Weekdays and weekends

calendar-isWeekday.Rd

Tests if a date is a weekday or not.

Usage

isWeekday(x, wday = 1:5)
isWeekend(x, wday = 1:5)

Arguments

x

an object of class "timeDate".

wday

Specify which days should be considered as weekdays. By default from Mondays to Fridays.

Value

a logical vector indicating if a date is a weekday or a weekend day

Examples

## dates in april, current year
currentYear = getRmetricsOptions("currentYear")
tS = timeSequence(
   from = paste(currentYear, "-03-01", sep = ""),
   to = paste(currentYear, "-04-30", sep = ""))
tS
#> GMT
#>  [1] [2025-03-01] [2025-03-02] [2025-03-03] [2025-03-04] [2025-03-05]
#>  [6] [2025-03-06] [2025-03-07] [2025-03-08] [2025-03-09] [2025-03-10]
#> [11] [2025-03-11] [2025-03-12] [2025-03-13] [2025-03-14] [2025-03-15]
#> [16] [2025-03-16] [2025-03-17] [2025-03-18] [2025-03-19] [2025-03-20]
#> [21] [2025-03-21] [2025-03-22] [2025-03-23] [2025-03-24] [2025-03-25]
#> [26] [2025-03-26] [2025-03-27] [2025-03-28] [2025-03-29] [2025-03-30]
#> [31] [2025-03-31] [2025-04-01] [2025-04-02] [2025-04-03] [2025-04-04]
#> [36] [2025-04-05] [2025-04-06] [2025-04-07] [2025-04-08] [2025-04-09]
#> [41] [2025-04-10] [2025-04-11] [2025-04-12] [2025-04-13] [2025-04-14]
#> [46] [2025-04-15] [2025-04-16] [2025-04-17] [2025-04-18] [2025-04-19]
#> [51] [2025-04-20] [2025-04-21] [2025-04-22] [2025-04-23] [2025-04-24]
#> [56] [2025-04-25] [2025-04-26] [2025-04-27] [2025-04-28] [2025-04-29]
#> [61] [2025-04-30]

## subset of weekends
isWeekend(tS)
#> 2025-03-01 2025-03-02 2025-03-03 2025-03-04 2025-03-05 2025-03-06 2025-03-07 
#>       TRUE       TRUE      FALSE      FALSE      FALSE      FALSE      FALSE 
#> 2025-03-08 2025-03-09 2025-03-10 2025-03-11 2025-03-12 2025-03-13 2025-03-14 
#>       TRUE       TRUE      FALSE      FALSE      FALSE      FALSE      FALSE 
#> 2025-03-15 2025-03-16 2025-03-17 2025-03-18 2025-03-19 2025-03-20 2025-03-21 
#>       TRUE       TRUE      FALSE      FALSE      FALSE      FALSE      FALSE 
#> 2025-03-22 2025-03-23 2025-03-24 2025-03-25 2025-03-26 2025-03-27 2025-03-28 
#>       TRUE       TRUE      FALSE      FALSE      FALSE      FALSE      FALSE 
#> 2025-03-29 2025-03-30 2025-03-31 2025-04-01 2025-04-02 2025-04-03 2025-04-04 
#>       TRUE       TRUE      FALSE      FALSE      FALSE      FALSE      FALSE 
#> 2025-04-05 2025-04-06 2025-04-07 2025-04-08 2025-04-09 2025-04-10 2025-04-11 
#>       TRUE       TRUE      FALSE      FALSE      FALSE      FALSE      FALSE 
#> 2025-04-12 2025-04-13 2025-04-14 2025-04-15 2025-04-16 2025-04-17 2025-04-18 
#>       TRUE       TRUE      FALSE      FALSE      FALSE      FALSE      FALSE 
#> 2025-04-19 2025-04-20 2025-04-21 2025-04-22 2025-04-23 2025-04-24 2025-04-25 
#>       TRUE       TRUE      FALSE      FALSE      FALSE      FALSE      FALSE 
#> 2025-04-26 2025-04-27 2025-04-28 2025-04-29 2025-04-30 
#>       TRUE       TRUE      FALSE      FALSE      FALSE 
tS[isWeekend(tS)]
#> GMT
#>  [1] [2025-03-01] [2025-03-02] [2025-03-08] [2025-03-09] [2025-03-15]
#>  [6] [2025-03-16] [2025-03-22] [2025-03-23] [2025-03-29] [2025-03-30]
#> [11] [2025-04-05] [2025-04-06] [2025-04-12] [2025-04-13] [2025-04-19]
#> [16] [2025-04-20] [2025-04-26] [2025-04-27]