File: checkListElementClass.Rd

package info (click to toggle)
r-cran-bbmisc 1.13.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,256 kB
  • sloc: ansic: 176; sh: 9; makefile: 5
file content (27 lines) | stat: -rw-r--r-- 680 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/checkListElementClass.R
\name{checkListElementClass}
\alias{checkListElementClass}
\title{Check that a list contains only elements of a required type}
\usage{
checkListElementClass(xs, cl)
}
\arguments{
\item{xs}{[\code{list}]\cr
Argument.}

\item{cl}{[\code{character(1)}]\cr
Class that elements must have. Checked with \code{is}.}
}
\value{
Nothing.
}
\description{
Check that argument is a list and contains only elements of a required type.
Throws exception if check is not passed.
Note that argument is evaluated when checked.
}
\examples{
xs = as.list(1:3)
checkListElementClass(xs, "numeric")
}