LiNk-NY authored on 18/10/2024 22:04:04
| ... | ... |
@@ -4,13 +4,31 @@ |
| 4 | 4 |
\name{TENxFile-class}
|
| 5 | 5 |
\alias{TENxFile-class}
|
| 6 | 6 |
\alias{.TENxFile}
|
| 7 |
+\alias{metadata,TENxFile-method}
|
|
| 7 | 8 |
\title{TENxFile: General purpose class for 10X files}
|
| 9 |
+\usage{
|
|
| 10 |
+\S4method{metadata}{TENxFile}(x, ...)
|
|
| 11 |
+} |
|
| 12 |
+\arguments{
|
|
| 13 |
+\item{x}{An object of class \code{TENxFile}, \code{TENxFileList}, \code{TENxMTX}, \code{TENxH5},
|
|
| 14 |
+\code{TENxPeaks}, \code{TENxTSV}, or derivatives}
|
|
| 15 |
+ |
|
| 16 |
+\item{...}{Additional arguments (not used)}
|
|
| 17 |
+} |
|
| 18 |
+\value{
|
|
| 19 |
+A list of metadata for the given object |
|
| 20 |
+} |
|
| 8 | 21 |
\description{
|
| 9 | 22 |
The \code{TENxFile} class is the default representation for
|
| 10 | 23 |
unrecognized subclasses. It inherits from the BiocFile class and adds a few |
| 11 | 24 |
additional slots. The constructor function can handle typical 10X file |
| 12 | 25 |
types. For more details, see the constructor function documentation. |
| 13 | 26 |
} |
| 27 |
+\section{Functions}{
|
|
| 28 |
+\itemize{
|
|
| 29 |
+\item \code{metadata(TENxFile)}: \code{metadata} method for \code{TENxFile} objects
|
|
| 30 |
+ |
|
| 31 |
+}} |
|
| 14 | 32 |
\section{Slots}{
|
| 15 | 33 |
|
| 16 | 34 |
\describe{
|
LiNk-NY authored on 17/10/2022 22:43:29
LiNk-NY authored on 15/08/2022 20:14:17
| ... | ... |
@@ -22,5 +22,8 @@ file that will subsequently be imported} |
| 22 | 22 |
|
| 23 | 23 |
\item{\code{rowidx}}{integer(1) The row index corresponding to rows in the file that
|
| 24 | 24 |
will subsequently be imported} |
| 25 |
+ |
|
| 26 |
+\item{\code{remote}}{logical(1) Whether the file exists on the web, i.e., the
|
|
| 27 |
+\code{resource} is a URL}
|
|
| 25 | 28 |
}} |
| 26 | 29 |
|
LiNk-NY authored on 13/06/2022 20:23:55
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,26 @@ |
| 1 |
+% Generated by roxygen2: do not edit by hand |
|
| 2 |
+% Please edit documentation in R/TENxFile-class.R |
|
| 3 |
+\docType{class}
|
|
| 4 |
+\name{TENxFile-class}
|
|
| 5 |
+\alias{TENxFile-class}
|
|
| 6 |
+\alias{.TENxFile}
|
|
| 7 |
+\title{TENxFile: General purpose class for 10X files}
|
|
| 8 |
+\description{
|
|
| 9 |
+The \code{TENxFile} class is the default representation for
|
|
| 10 |
+unrecognized subclasses. It inherits from the BiocFile class and adds a few |
|
| 11 |
+additional slots. The constructor function can handle typical 10X file |
|
| 12 |
+types. For more details, see the constructor function documentation. |
|
| 13 |
+} |
|
| 14 |
+\section{Slots}{
|
|
| 15 |
+ |
|
| 16 |
+\describe{
|
|
| 17 |
+\item{\code{extension}}{character(1) The file extension as extracted from the file
|
|
| 18 |
+path or overridden via the \code{ext} argument in the constructor function.}
|
|
| 19 |
+ |
|
| 20 |
+\item{\code{colidx}}{integer(1) The column index corresponding to the columns in the
|
|
| 21 |
+file that will subsequently be imported} |
|
| 22 |
+ |
|
| 23 |
+\item{\code{rowidx}}{integer(1) The row index corresponding to rows in the file that
|
|
| 24 |
+will subsequently be imported} |
|
| 25 |
+}} |
|
| 26 |
+ |