CosinorSignificantPlot: CosinorSignificantPlot :

Description Usage Arguments Value Examples

View source: R/cosinor_functions.R

Description

Prints or saves the genes found to be most significant by CosinorAnalysis.

Usage

1
2
3
4
5
6
7
8
9
CosinorSignificantPlot(
  results,
  dataset,
  number = 10,
  period = 24,
  print = TRUE,
  save = FALSE,
  path = NULL
)

Arguments

results

A dataframe generated by CosinorAnalysis.

dataset

A transcriptomics dataset which was used with CosinorAnalysis to generate the results dataframe. First columns should be gene names. All other columns should be expression levels.

number

The number of most significant genes printed or saved.

period

The period of rhythmicity which is being tested for. Defaults to 24 (circadian).

print

Logical. If TRUE renders significant genes in the plot viewer. Defaults to TRUE.

save

Logical. If TRUE, saves plots to working directory. Defaults to FALSE.

path

The path to be used for saving plots to. Only used if save is TRUE. If not specified then path will be based off name of the results object.

Value

Prints or saves ggplot2 object(s).

Examples

1
2
3
cosinor.results <- CosinorAnalysis(Laurasmappings)
CosinorSignificantPlot(cosinor.results, Laurasmappings, number = 15,
                        period = 24, save = TRUE, path = "example")

nathansam/CircadianTools documentation built on Dec. 26, 2019, 11:30 a.m.