fcgo_volcano_plot: Make A Volcano Plot

Description Usage Arguments Value

View source: R/fc_graphic_output.R

Description

Plots p-values versus fold change values. Points are colored by detection reagant and shaped by antigen being detected.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
fcgo_volcano_plot(
  foch,
  p_vals,
  line_method,
  main,
  xlab,
  ylab,
  gopts,
  pt_colors,
  pt_shapes
)

Arguments

foch

A vector of fold change values.

p_vals

A vector of p-values.

line_method

A string indicating the method you want to use to draw the arbitrary cutoff line. "bonferroni" (for p < 0.05), "fdr" (for q < 0.2), and "raw" (just -log10(0.05)) are supported.

main

The title of the plot.

xlab

The label for the x-axis.

ylab

The label for the y-axis.

gopts

A list of graphical options. Must have specified the subparameters:

  • gopts$volc_xlim The x-limits for the volcano plot.

  • gopts$volc_ylim The y-limits for the volcano plot.

  • gopts$reag_legend_inset The inset for the legend relative to the plot. Reasonable place to start is c(-0.18, 0).

  • gopts$reag_cats The categories for your detection reagants.

  • gopts$reag_cols The colors for the detection reagant categories.

  • gopts$ant_shapes The shapes for the antigens being detected.

pt_colors

Colors for each point in p_vals. These should be generated from gopts$reag_cols. See ?fcgo_get_prop for an example of how to generate this.

pt_shapes

Shapes for each point in p_vals. These should be generated from gopts$ant_shapes. See ?fcgo_get_prop for an example of how to generate this.

Value

Nothing!


kmorrisongr/fcan documentation built on Sept. 9, 2020, 10:12 a.m.