Browse code

include docs for slots

LiNk-NY authored on 14/07/2022 02:32:40
Showing 2 changed files

... ...
@@ -126,6 +126,8 @@ setMethod("import", "TSVFile", function(con, format, text, ...) {
126 126
 #' @describeIn TENxFileList-class Obtain file paths for all files in the object
127 127
 #'   as a vector
128 128
 #'
129
+#' @inheritParams BiocGenerics::path
130
+#'
129 131
 #' @export
130 132
 setMethod("path", "TENxFileList", function(object, ...) {
131 133
     vapply(object, .get_path, character(1L))
... ...
@@ -15,6 +15,17 @@
15 15
 
16 16
 \S4method{import}{TENxFileList,ANY,ANY}(con, format, text, ...)
17 17
 }
18
+\arguments{
19
+\item{object}{
20
+    An object containing paths. Even though it will typically contain
21
+    a single path, \code{object} can actually contain an arbitrary
22
+    number of paths.
23
+  }
24
+
25
+\item{...}{
26
+    Additional arguments, for use in specific methods.
27
+  }
28
+}
18 29
 \description{
19 30
 This class was designed to mainly handle tarballs from
20 31
 10X Genomics. The typical file extension for these tarballs is \code{.tar.gz}.