Plot predicted or clinical sex from predictSexMinfiEwasWater()

Source: R/preprocessingMinfiEwasWater_steps.R

Plot predicted or clinical sex from predictSexMinfiEwasWater()

plotSexMinfiEwasWater(
  sexData,
  type = c("predicted", "clinical"),
  display = FALSE,
  file = NULL,
  width = 2000L,
  height = 1000L,
  res = 70L,
  verbose = FALSE,
  logs = FALSE,
  log_dir = NULL,
  log_file = "log_plotSexMinfiEwasWater.txt"
)

Arguments

sexData

Object returned by predictSexMinfiEwasWater().

type

Character. Plot type: "predicted" for methylation-predicted sex or "clinical" for reported sex.

display

Logical. If TRUE, draw the plot on the active graphics device.

file

Character or NULL. TIFF file written when supplied.

width

Integer. TIFF width in pixels when file is supplied.

height

Integer. TIFF height in pixels when file is supplied.

res

Integer. TIFF resolution in DPI when file is supplied.

verbose

Logical. If TRUE, emit progress messages with message().

logs

Logical. If TRUE, write the same messages to a log file.

log_dir

Character or NULL. Directory used for the log file when logs = TRUE.

log_file

Character. File name used when logs = TRUE.

Value

Invisibly returns the saved TIFF path when file is supplied, otherwise NULL.

Examples

ex <- dnaEPICO:::exampleSexPlotStateDnaEpico()
plotSexMinfiEwasWater(
  sexData = ex,
  type = "predicted",
  display = FALSE,
  verbose = FALSE,
  logs = FALSE
)