forked from google/GeoexperimentsResearch
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CheckForBadValues.Rd
33 lines (26 loc) · 928 Bytes
/
CheckForBadValues.Rd
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
% Copyright (C) 2017 Google, Inc.
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils_assert.R
\name{CheckForBadValues}
\alias{CheckForBadValues}
\title{Checks for bad values in given columns.}
\usage{
CheckForBadValues(x, columns, CHECK, good = TRUE, what = "invalid", ...)
}
\arguments{
\item{x}{(data frame) any data frame.}
\item{columns}{(character) columns to check.}
\item{CHECK}{(function) function that returns a logical vector (of length
\code{nrow(x)}).}
\item{good}{(logical) the value or values that indicate a 'good' value.
Other values returned by 'CHECK' will be 'bad' and throw an error.}
\item{what}{(string) a string to display in the informative message.}
\item{...}{further arguments passed on to function 'CHECK'.}
}
\value{
If all tests pass, returns NULL invisibly. Otherwise, an
'assertError' is thrown.
}
\description{
Checks for bad values in given columns.
}