-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcheck....Rd
26 lines (25 loc) · 1.12 KB
/
check....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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{check...}
\alias{check...}
\title{Check that arguments supplied via \code{...} are allowed}
\source{
This function is taken from the `utils.add' package (https://github.com/edwardlavender/utils.add). It is defined separately in \code{\link[flapper]{flapper}} to reduce reliance on non-default packages.
}
\usage{
check...(not_allowed, ...)
}
\arguments{
\item{not_allowed}{A character vector of the names of function arguments that are not allowed.}
\item{...}{Arguments passed via \code{...} to a parent function.}
}
\value{
The function checks arguments supplied via \code{...}; if these contain an argument that is not allowed, the function returns an error. Otherwise, nothing is returned.
}
\description{
This function checks that arguments supplied via \code{...} are allowed. This function was written to support other functions, specifically via the return of a helpful error message if arguments that cannot be supplied via \code{...} have been supplied. The function is not intended for general use.
}
\author{
Edward Lavender
}
\keyword{internal}