Added concepts

pachterlab · Nov 14, 2024 · 4ccec45 · 4ccec45
1 parent a0765d4
commit 4ccec45
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 0 deletions.
diff --git a/R/listw2sparse.R b/R/listw2sparse.R
@@ -18,6 +18,7 @@
 #'   it will be the row and column names of the output matrix.
 #' @export
 #' @importFrom Matrix sparseMatrix
+#' @concept Spatial neighborhood graph
 #' @examples
 #' library(SFEData)
 #' sfe <- McKellarMuscleData("small")
@@ -47,6 +48,7 @@ listw2sparse <- function(listw) {
 #' When the input is an SFE object, the rows and columns will match the column
 #' names of the SFE object.
 #' @export
+#' @concept Spatial neighborhood graph
 #' @examples
 #' # example code
 #'

diff --git a/R/read.R b/R/read.R
@@ -310,6 +310,7 @@ read10xVisiumSFE <- function(samples = "",
 #'   not zooming in. See the \code{scattermore} argument in
 #'   \code{\link[Voyager]{plotSpatialFeature}}.
 #' @export
+#' @concept Read data into SFE
 #' @examples
 #' #
 readVisiumHD <- function(data_dir, bin_size = c(2L, 8L, 16L), 

diff --git a/R/utils.R b/R/utils.R
@@ -228,6 +228,7 @@ gdalParquetAvailable <- function() {
 #' \item{\code{fn}}{File path of the transcript spot file.}
 #' }
 #' @export
+#' @concept Utilities
 getTechTxFields <- function(tech, data_dir = NULL) {
     spatialCoordsNames <- switch(
         tech,

diff --git a/man/getTechTxFields.Rd b/man/getTechTxFields.Rd
diff --git a/man/listw2sparse.Rd b/man/listw2sparse.Rd
diff --git a/man/multi_listw2sparse.Rd b/man/multi_listw2sparse.Rd
diff --git a/man/readVisiumHD.Rd b/man/readVisiumHD.Rd