File: AlignedDataFrame.Rd

package info (click to toggle)
r-bioc-shortread 1.32.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 8,384 kB
  • ctags: 293
  • sloc: ansic: 2,718; cpp: 202; sh: 3; makefile: 2
file content (38 lines) | stat: -rw-r--r-- 926 bytes parent folder | download | duplicates (4)
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
35
36
37
38
\name{AlignedDataFrame}
\alias{AlignedDataFrame}

\title{(Legacy) AlignedDataFrame constructor}
\description{

  Construct an \code{AlignedDataFrame} from a data frame and its
  metadata

}

\usage{
AlignedDataFrame(data, metadata, nrow = nrow(data))
}

\arguments{

  \item{data}{A data frame containing alignment information.}

  \item{metadata}{A data frame describing the columns of \code{data},
    and with number of rows of \code{metadata} corresponding to number
    of columns of \code{data}. . The data frame must contain a column
    \code{labelDescription} providing a verbose description of each
    column of \code{data}.}

  \item{nrow}{An optional argument, to be used when \code{data} is not
    provided, to construct an AlignedDataFrame with the specified number
    of rows.}
}
\value{

  An object of \code{\linkS4class{AlignedDataFrame}}.

}

\author{Martin Morgan <mtmorgan@fhcrc.org>}

\keyword{manip}