File: date_spanning_seq.Rd

package info (click to toggle)
r-cran-clock 0.7.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,856 kB
  • sloc: cpp: 19,564; sh: 17; makefile: 2
file content (50 lines) | stat: -rw-r--r-- 1,385 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/date.R
\name{date_spanning_seq}
\alias{date_spanning_seq}
\title{Spanning sequence: date and date-time}
\usage{
date_spanning_seq(x)
}
\arguments{
\item{x}{\verb{[Date / POSIXct / POSIXlt]}

A date or date-time vector.}
}
\value{
A sequence along \verb{[min(x), max(x)]}.
}
\description{
\code{date_spanning_seq()} generates a regular sequence along the span of
\code{x}, i.e. along \verb{[min(x), max(x)]}. For dates, this generates a day precision
sequence, and for date-times it generates a second precision sequence.
}
\details{
Missing and infinite values are automatically removed before the sequence is
generated.

For date-times, sys-time based sequences are generated, consistent with
\code{\link[=posixt-sequence]{date_seq()}} when using a second precision \code{by} value.

If you need more precise sequence generation, call \code{\link[=range]{range()}} and \code{\link[=date_seq]{date_seq()}}
directly.
}
\examples{
x <- date_build(2020, c(1, 2, 1), c(10, 5, 12))
date_spanning_seq(x)

# Missing and infinite dates are removed before the sequence is generated
x <- c(x, NA, Inf, -Inf)
x

date_spanning_seq(x)

# For date-times, sequences are generated at second precision
x <- date_time_build(
  2020, 1, 2, 3, c(5, 4, 5), c(10, 48, 12),
  zone = "America/New_York"
)
x

date_spanning_seq(x)
}