man/pcaplot3d.Rd
4a1e5b31
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/pcaplot.R
 \name{pcaplot3d}
 \alias{pcaplot3d}
 \title{Sample PCA plot for transformed data}
 \usage{
8fa4a88a
 pcaplot3d(
   x,
   intgroup = "condition",
   ntop = 500,
   returnData = FALSE,
   title = NULL,
   pcX = 1,
   pcY = 2,
   pcZ = 3,
   text_labels = TRUE,
   point_size = 3
 )
4a1e5b31
 }
 \arguments{
9c694b25
 \item{x}{A \code{\link[DESeq2:DESeqTransform]{DESeq2::DESeqTransform()}} object, with data in \code{assay(x)},
 produced for example by either \code{\link[DESeq2:rlog]{DESeq2::rlog()}} or
 \code{\link[DESeq2:varianceStabilizingTransformation]{DESeq2::varianceStabilizingTransformation()}}}
4a1e5b31
 
d42f9869
 \item{intgroup}{Interesting groups: a character vector of
 names in \code{colData(x)} to use for grouping}
 
4a1e5b31
 \item{ntop}{Number of top genes to use for principal components,
 selected by highest row variance}
 
 \item{returnData}{logical, if TRUE returns a data.frame for further use, containing the
 selected principal components and intgroup covariates for custom plotting}
 
 \item{title}{The plot title}
 
 \item{pcX}{The principal component to display on the x axis}
 
 \item{pcY}{The principal component to display on the y axis}
 
 \item{pcZ}{The principal component to display on the z axis}
 
 \item{text_labels}{Logical, whether to display the labels with the sample identifiers}
 
 \item{point_size}{Integer, the size of the points for the samples}
d42f9869
 }
 \value{
 A html-based visualization of the 3d PCA plot
4a1e5b31
 }
 \description{
 Plots the results of PCA on a 3-dimensional space, interactively
 }
d42f9869
 \examples{
c8e298cb
 dds <- makeExampleDESeqDataSet_multifac(betaSD_condition = 3, betaSD_tissue = 1)
d42f9869
 rlt <- DESeq2::rlogTransformation(dds)
c8e298cb
 pcaplot3d(rlt, ntop = 200)
d42f9869
 }