is_linear_sequence  R Documentation 
A variable X = (x_1, x_2,\ldots, x_n)
(n\geq 0
) represents a
linear sequence when x_{j+1}  x_j
is constant for all
j\geq 1
. That is, elements in the series are equidistant and without
gaps.
is_linear_sequence(x, by = NULL, ...)
## S3 method for class 'numeric'
is_linear_sequence(
x,
by = NULL,
begin = NULL,
end = NULL,
sort = TRUE,
tol = 1e08,
...
)
## S3 method for class 'Date'
is_linear_sequence(x, by = NULL, begin = NULL, end = NULL, sort = TRUE, ...)
## S3 method for class 'POSIXct'
is_linear_sequence(
x,
by = NULL,
begin = NULL,
end = NULL,
sort = TRUE,
tol = 1e06,
...
)
## S3 method for class 'character'
is_linear_sequence(
x,
by = NULL,
begin = NULL,
end = NULL,
sort = TRUE,
format = "auto",
...
)
in_linear_sequence(x, ...)
## S3 method for class 'character'
in_linear_sequence(
x,
by = NULL,
begin = NULL,
end = NULL,
sort = TRUE,
format = "auto",
...
)
## S3 method for class 'numeric'
in_linear_sequence(
x,
by = NULL,
begin = NULL,
end = NULL,
sort = TRUE,
tol = 1e08,
...
)
## S3 method for class 'Date'
in_linear_sequence(x, by = NULL, begin = NULL, end = NULL, sort = TRUE, ...)
## S3 method for class 'POSIXct'
in_linear_sequence(
x,
by = NULL,
begin = NULL,
end = NULL,
sort = TRUE,
tol = 1e06,
...
)
x 
An R vector. 
by 
bare (unquoted) variable name or a list of unquoted variable names,
used to split 
... 
Arguments passed to other methods. 
begin 
Optionally, a value that should equal 
end 
Optionally, a value that should equal 
sort 

tol 
numerical tolerance for gaps. 
format 

Presence of a missing value (NA
) in x
will result in NA
,
except when length(x) <= 2
and start
and end
are
NULL
. Any sequence of length \leq 2
is a linear sequence.
For is_linear_sequence
: a single TRUE
or FALSE
,
equal to all(in_linear_sequence)
.
For in_linear_sequence
: a logical
vector with the same length as x
.
Other crossrecordhelpers:
contains_exactly()
,
do_by()
,
exists_any()
,
hb()
,
hierarchy()
,
is_complete()
,
is_unique()
is_linear_sequence(1:5) # TRUE
is_linear_sequence(c(1,3,5,4,2)) # FALSE
is_linear_sequence(c(1,3,5,4,2), sort=TRUE) # TRUE
is_linear_sequence(NA_integer_) # TRUE
is_linear_sequence(NA_integer_, begin=4) # FALSE
is_linear_sequence(c(1, NA, 3)) # FALSE
d < data.frame(
number = c(pi, exp(1), 7)
, date = as.Date(c("20151217","20151219","20151221"))
, time = as.POSIXct(c("20151217","20151219","20151220"))
)
rules < validator(
is_linear_sequence(number) # fails
, is_linear_sequence(date) # passes
, is_linear_sequence(time) # fails
)
summary(confront(d,rules))
## check groupwise data
dat < data.frame(
time = c(2012, 2013, 2012, 2013, 2015)
, type = c("hi", "hi", "ha", "ha", "ha")
)
rule < validator(in_linear_sequence(time, by=type))
values(confront(dat, rule)) ## 2xT, 3xF
rule < validator(in_linear_sequence(time, type))
values( confront(dat, rule) )
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.