check {MIfuns}R Documentation

Check Some Properties of Vectors and Data Frames (beta)

Description

maxChar() returns the number of printed characters for the widest element of x. prev() calculates the previous element for each element in x. runhead() determines whether each element is the "head" (start) of a run sorted() checks whether x (data.frame) is sorted on the columns specified.

Usage

maxChar(x)
prev(x)
runhead(x)
sorted(x, on)

Arguments

x a data.frame for sorted(); otherwise a vector.
on a character vector of column names in x.

Details

If you forget to round() or signif() a numeric column, you may get more digits than desired in your output file; maxChar() can warn you. See examples.

prev() is used by runhead. Note that there is no element previous to the first element in a vector, so prev() returns NA in that position.

If a 'run' is a sequence (possibly of length one) of identical successive values in a vector, runhead determines whether an element is the first in such a sequence. Note that by definition, the first element is the start of a run; Thus runhead() returns TRUE in that position, even though prev() returns NA.

Value

maxChar(): an atomic integer prev(): a vector of the same class runhead(): a vector of logicals sorted(): an atomic logical

Note

NAs in the argument to runhead() give surprising but reasonable results. It cannot be known whether they are the heads of runs, nor can it be known whether values immediately following them are heads of runs. To treat NAs deterministically, convert to some definite value first.

Author(s)

Tim Bergsma

Examples

maxChar(c(1.2,1.234))
prev(c(1,2,NA,3,3,NA,4))
runhead(c(1,2,NA,3,3,NA,4))
sorted(Theoph,on="Subject")#FALSE: note ordered factor.

[Package MIfuns version 3.2.9 Index]