File: comparedf.tolerances.Rd

package info (click to toggle)
r-cran-arsenal 3.6.3-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,788 kB
  • sloc: sh: 18; makefile: 5
file content (73 lines) | stat: -rw-r--r-- 1,738 bytes parent folder | download | duplicates (3)
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/comparedf.tolerances.R
\name{comparedf.tolerances}
\alias{comparedf.tolerances}
\alias{tol.NA}
\alias{tol.num.absolute}
\alias{tol.num.percent}
\alias{tol.num.pct}
\alias{tol.factor.none}
\alias{tol.factor.levels}
\alias{tol.factor.labels}
\alias{tol.char.both}
\alias{tol.char.case}
\alias{tol.char.trim}
\alias{tol.char.none}
\alias{tol.date.absolute}
\alias{tol.logical.none}
\alias{tol.other.none}
\title{\code{comparedf} tolerances}
\usage{
tol.NA(x, y, idx)

tol.num.absolute(x, y, tol)

tol.num.percent(x, y, tol)

tol.num.pct(x, y, tol)

tol.factor.none(x, y)

tol.factor.levels(x, y)

tol.factor.labels(x, y)

tol.char.both(x, y)

tol.char.case(x, y)

tol.char.trim(x, y)

tol.char.none(x, y)

tol.date.absolute(x, y, tol)

tol.logical.none(x, y)

tol.other.none(x, y)
}
\arguments{
\item{x, y}{vectors of the appropriate lengths and types.}

\item{idx}{A logical vector of appropriate length.}

\item{tol}{A numeric tolerance}
}
\value{
A logical vector of length equal to that of \code{x} and \code{y}, where \code{TRUE} denotes a
  difference between \code{x} and \code{y}, and \code{FALSE} denotes no difference between \code{x} and \code{y}.
}
\description{
Internal functions defining tolerances for the \code{\link{comparedf.control}} function.
  To create your own tolerance definitions, see the vignette.
}
\details{
\code{tol.NA} takes as differences between two vectors any elements which are NA in one but not the other,
  or which are non-NA in both and \code{TRUE} in \code{idx}. It is useful for handling NAs in custom tolerance functions.
}
\seealso{
\code{\link{comparedf.control}}, \code{\link{comparedf}}
}
\author{
Ethan Heinzen
}