R: Making a 'timeDate' object unique

align {timeDate} | R Documentation

## Making a 'timeDate' object unique

### Description

Aligns a 'timeDate' object to regular date/time stamps.

### Usage

    ## S4 method for signature 'timeDate'
    align(x, by = "1d", offset = "0s")

    alignDaily(x, include.weekends=FALSE)
    alignMonthly(x, include.weekends=FALSE)
    alignQuarterly(x, include.weekends=FALSE)

### Arguments

`x` | an object of class `timeDate`.
`by` | a character string formed from an integer length and a period identifyer. Valid values are "w", "d", "h", "m", "s", for weeks, days, hours, minutes and seconds. For example a bi-weekly period is expressed as `"2w"`.
`offset` | a character string to set an offset formed from an integer length and a period identifyer in the same way as for the argument `by`.
`include.weekends` | logical value indicating whether 'weekends' should be included.

### Details

The functions `alignDaily`, `alignMonthly`, `alignMonthly` are simple to use functions which generate end-of-day, end-of-month, and end-of quarter `timeDate` objects. Weekends are excluded by default. Optionally they can be added setting the argument `include.weekends=TRUE`.

### Value

returns an object of class `timeDate`.

### Examples

    ## align -

    # Align Bi-Weekly with a 3 Days Offset:
    (tC <- timeCalendar())
    align(tC, by = "2w", offset = "3d")

    ## alignDaily -

    # Simple to use Functions:
    alignDaily(tC)
    alignDaily(tC, include.weekends=TRUE)

    # Align to end-of-month Dates:
    alignMonthly(tC)

[Package timeDate version 3012.100 Index]