seq_length: Set sequence length

In lhdjung/scrutiny: Error Detection in Science

Set sequence length

Description

seq_length() seamlessly extends or shortens a linear sequence using the sequence's own step size.

Alternatively, you can directly set the length of a linear sequence in this way: seq_length(x) <- value.

Usage

seq_length(x, value)

seq_length(x) <- value

Arguments

x	Numeric or coercible to numeric. x must be linear, i.e., each of its elements must differ from the next by the same amount.
value	Numeric (whole number, length 1). The new length for x.

Value

A vector of the same type as x, with length value.

• If value > length(x), all original element of x are preserved. A number of new elements equal to the difference is appended at the end.

• If value == length(x), nothing changes.

• If value < length(x), a number of elements of x equal to the difference is removed from the end.

Examples

x <- 3:7

# Increase the length of `x` from 5 to 10:
seq_length(x, 10)

# Modify `x` directly (but get
# the same results otherwise):
seq_length(x) <- 10
x

# Likewise, decrease the length:
x <- 3:7
seq_length(x, 2)

seq_length(x) <- 2
x

# The functions are sensitive to decimal levels.
# They also return a string vector if (and only if)
# `x` is a string vector:
x <- seq_endpoint(from = 0, to = 0.5)
x

seq_length(x, 10)

seq_length(x) <- 10
x

# Same with decreasing the length:
seq_length(x, 2)

seq_length(x) <- 2
x

lhdjung/scrutiny documentation built on Sept. 28, 2024, 12:14 a.m.