Skip to content

Commit

Permalink
Added documentation for int_diff
Browse files Browse the repository at this point in the history
  • Loading branch information
garrettgman committed Mar 18, 2012
1 parent 0b24b1e commit 737b547
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions man/int_diff.Rd
@@ -0,0 +1,25 @@
\name{int_diff}
\alias{int_diff}
\title{Extract the intervals within a vector of date-times}
\usage{
int_diff(times)
}
\arguments{
\item{times}{A vector of POSIXct, POSIXlt or Date class
date-times}
}
\value{
An interval object that contains the n-1 intervals
between the n date-tiwe in times
}
\description{
int_diff returns the intervals that occur between the
elements of a vector of date-times. int_diff is similar
to the POSIXt and Date methods of \code{\link{diff}}, but
returns an interval object instead of a difftime object.
}
\examples{
dates <- now() + days(1:10)
int_diff(dates)
}

0 comments on commit 737b547

Please sign in to comment.