File: addCDS.Rd

package info (click to toggle)
r-bioc-tximeta 1.16.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 860 kB
  • sloc: makefile: 2
file content (30 lines) | stat: -rw-r--r-- 1,160 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/addRanges.R
\name{addCDS}
\alias{addCDS}
\title{Add CDS to rowRanges of a transcript-level SummarizedExperiment}
\usage{
addCDS(se)
}
\arguments{
\item{se}{the SummarizedExperiment}
}
\value{
a SummarizedExperiment
}
\description{
Working similarly to \code{\link{addExons}}, this function
can be used to add information about CDS (coding sequence)
to the \code{SummarizedExperiment} object. As not all transcripts
are coding, we have CDS information for only a subset of the
rows of the object. For this reason, a logical indicator for
whether the transcript is coding, \code{mcols(se)$coding},
is added as a column to the metadata columns of the \code{rowRanges}
of the object. An additional column, \code{mcols(se)$cds},
is added to the metadata columns, which is a \code{GRangesList}
with either the CDS regions (if the transcript is coding),
or the original transcript/exon ranges (if the transcript is non-coding).
This is necessary, as \code{GRangesList} cannot have NA elements.
As with \code{\link{addExons}}, this function is designed only
for transcript-level objects.
}