File: sampleClustering.Rd

package info (click to toggle)
r-bioc-nanostringqcpro 1.30.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 872 kB
  • sloc: makefile: 7
file content (34 lines) | stat: -rw-r--r-- 902 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/NanoStringQualityMetrics.R
\docType{methods}
\name{sampleClustering,RccSet-method}
\alias{sampleClustering,RccSet-method}
\alias{sampleClustering}
\title{Clustering by sample correlation}
\usage{
\S4method{sampleClustering}{RccSet}(rccSet, outputFile,
  main = "Sample correlations in raw data", annCol = NULL,
  covar = "SampleType")
}
\arguments{
\item{rccSet}{An RccSet}

\item{outputFile}{Output PNG filename}

\item{main}{Plot title}

\item{annCol}{See \code{\link{aheatmap}}}

\item{covar}{Covariate (e.g. "SampleType")}
}
\value{
A PNG file showing clustering of samples by correlation. Any zero-variance
samples are omitted from the heatmap.
The width and height of the PNG file are set to vary with the size of the input.
}
\description{
Clustering by sample correlation
}
\author{
Dorothee Nickles, Robert Ziman
}