ClusterCorDatasetPlot: ClusterCorDatasetPlot

Description Usage Arguments Value Examples

View source: R/cluster_functions.R

Description

Uses ClusterCorPlot to plot all of the clusters generated by a clustering method when absolute Pearson's correlation was used as a distance measure.

Usage

1
2
3
4
5
6
7
ClusterCorDatasetPlot(
  cluster.dataset,
  nthreads = NULL,
  print = TRUE,
  save = FALSE,
  path = NULL
)

Arguments

cluster.dataset

A transcriptomics dataset where the final column details the cluster the gene belongs to. First column should be gene names. All remaining columns should be expression levels.

nthreads

Number of processor threads for the process. If not specified then the maximum number of logical cores are used.

print

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

save

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

path

The directory to be used for saving plots to. Uses the working directory by default. Not used if save=FALSE

Value

Prints or saves a ggplot2 object.

Examples

1
2
3
pam.df <- PamClustering(Laurasmappings, k = 10, metric = "abs.correlation",
                        nthreads = 2)
ClusterCorDatasetPlot(pam.df, nthreads = 2)

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