% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/preprocessingMinfiEwasWater_steps.R
\name{plotCtrlMinfiEwasWater}
\alias{plotCtrlMinfiEwasWater}
\title{Plot ENmix control images from an RGSet}
\usage{
plotCtrlMinfiEwasWater(
  RGSet,
  output_dir = NULL,
  verbose = FALSE,
  logs = FALSE,
  log_dir = NULL,
  log_file = "log_plotCtrlMinfiEwasWater.txt"
)
}
\arguments{
\item{RGSet}{An \code{RGChannelSet}.}

\item{output_dir}{Character or \code{NULL}. Directory where ENmix control JPG
files should be written. If \code{NULL}, the function returns without writing
files.}

\item{verbose}{Logical. If \code{TRUE}, emit progress messages with \code{message()}.}

\item{logs}{Logical. If \code{TRUE}, write the same messages to a log file.}

\item{log_dir}{Character or \code{NULL}. Directory used for the log file when
\code{logs = TRUE}.}

\item{log_file}{Character. File name used when \code{logs = TRUE}.}
}
\value{
Invisibly returns \code{output_dir}.
}
\description{
Call \code{ENmix::plotCtrl()} for a supplied \code{RGSet}. This function only writes
files when \code{output_dir} is provided because \code{ENmix::plotCtrl()} produces JPG
files on disk rather than returning a plot object.
}
\examples{
\dontshow{if (requireNamespace("minfiData", quietly = TRUE)) withAutoprint(\{ # examplesIf}
ex <- dnaEPICO:::exampleMinfiBaseDataDnaEpico()
output_dir <- file.path(tempdir(), "enmix-control-plots")
plotCtrlMinfiEwasWater(
    RGSet = ex$RGSet,
    output_dir = output_dir,
    verbose = FALSE,
    logs = FALSE
)
dir.exists(output_dir)
\dontshow{\}) # examplesIf}
}
