% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/preprocessingMinfiEwasWater_steps.R
\name{plotMetricsMinfiEwasWater}
\alias{plotMetricsMinfiEwasWater}
\title{Plot multidimensional scaling or density summaries from final metrics}
\usage{
plotMetricsMinfiEwasWater(
  metricsData,
  targets,
  plot = c("mds", "density"),
  plotGroupVar = "Sex",
  sexColumn = "Sex",
  display = FALSE,
  file = NULL,
  width = 2000L,
  height = 1000L,
  res = 150L,
  verbose = FALSE,
  logs = FALSE,
  log_dir = NULL,
  log_file = "log_plotMetricsMinfiEwasWater.txt"
)
}
\arguments{
\item{metricsData}{Object returned by \code{extractMetricsMinfiEwasWater()}.}

\item{targets}{Filtered phenotype data aligned with \code{metricsData}.}

\item{plot}{Character. Plot type: \code{'mds'} or \code{'density'}.}

\item{plotGroupVar}{Character. Phenotype column used for the main grouping.}

\item{sexColumn}{Character. Phenotype column used for the sex grouping in the
MDS plot.}

\item{display}{Logical. If \code{TRUE}, draw the plot on the active graphics
device.}

\item{file}{Character or \code{NULL}. TIFF file written when supplied.}

\item{width}{Integer. TIFF width in pixels when \code{file} is supplied.}

\item{height}{Integer. TIFF height in pixels when \code{file} is supplied.}

\item{res}{Integer. TIFF resolution in DPI when \code{file} is supplied.}

\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 the saved TIFF path when \code{file} is supplied,
otherwise \code{NULL}.
}
\description{
Plot multidimensional scaling or density summaries from final metrics
}
\examples{
ex <- dnaEPICO:::exampleMinfiMetricsStateDnaEpico()
plotMetricsMinfiEwasWater(
    metricsData = ex$metricsData,
    targets = ex$targets,
    plot = "density",
    plotGroupVar = "Sex",
    sexColumn = "Sex",
    display = FALSE,
    verbose = FALSE,
    logs = FALSE
)

}
