File: checkRccSet.Rd

package info (click to toggle)
r-bioc-nanostringqcpro 1.30.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 872 kB
  • sloc: makefile: 7
file content (34 lines) | stat: -rw-r--r-- 882 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\docType{methods}
\name{checkRccSet,RccSet-method}
\alias{checkRccSet,RccSet-method}
\alias{checkRccSet}
\title{Check an RccSet}
\usage{
\S4method{checkRccSet}{RccSet}(rccSet, reportWarnings = TRUE,
  showMessages = FALSE)
}
\arguments{
\item{rccSet}{An RccSet to be checked.}

\item{reportWarnings}{Logical. If TRUE, warnings are reported.}

\item{showMessages}{Logical. If TRUE, notes are shown indicating any optional missing
columns and the like.}
}
\value{
Returns TRUE if no warnings were generated and FALSE otherwise.
}
\description{
Provides additional checks and generates warnings for unexpected or unusual conditions
which, though permitted by the RccSet class, may indicate data import errors.
}
\examples{
data(example_rccSet)
checkRccSet(example_rccSet)

}
\author{
Robert Ziman
}