runLmsPlots: Make a plot of a bunch of ROI stats from a linear model, per...

Description Usage Arguments Value

Description

Make a plot of a bunch of ROI stats from a linear model, per your specifications

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
runLmsPlots(
  plotList,
  termToPlot,
  x,
  y,
  interactionPlot = FALSE,
  boxOrScatter = "box",
  colorCol,
  colorMat = NULL,
  sigValue = 1,
  multipleCorrectionMethod = "none",
  outFileRoot = NULL
)

Arguments

plotList

A list object with 1st element a stats table organized as long in terms of Label.Names x term (from your lm output) The 2nd element is a data frame with columns "value", "label", "Label.Names", "resid", plus whatever you stuck into your lm() The width in the df should be organized as estimate, std.error, statistic, and p.value Needs raw values ("value"), as well as columns associated with each term in your regression Note that you can do this with only a single row, or a few select rows, but then don't use the function's multiple corrections tests

x

what you want on your x-axis. If it's a factor or character, this makes a boxplot. If it's a numeric, double, or integer, it's a scatterplot.

y

what you want on your y-axis. Almost certainly "value" or "resid"

interactionPlot

(logical) are you plotting an interaction effect? Should only be used when considering an interaction effect statistically. Default FALSE

boxOrScatter

"box" or "scatter" depending on how you want to visualize your data

colorCol

what you want to color by

colorMat

(optional) table of colors that might get used in plots. If used, might fight with colorCol. I need to practice

sigValue

value used for thresholding your statistics. If you want to show all data use 1 (default).

multipleCorrectionMethod

(optional) goes into p.adjust() to correct for multiple comparisons. Will do this accounting for all labels in your input df. Default is none, common alternatives are "bonferroni" and "fdr"

outFileRoot

(optional) Not implemented. file root for output. If specified, will save 1) .txt file with all significant results and 2) plots for up to 5 labels (with 5 smallest p-values)

termForSignificance

the term from your df you want to use for your stats. Must be from the "term" column of plotList[[1]]

Value

A list object with elements 1) a plot for each significant region per your specifications


caugolm/quants_qc_stats documentation built on Nov. 22, 2020, 4:26 p.m.