Skip to content

Commit 8f776f9

Browse files
committed
Add a note about deprecation of read10xVisium()
1 parent 8091b86 commit 8f776f9

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

R/read10xVisiumWrapper.R

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
#' analysis results from SpaceRanger by 10x Genomics as well as add information
55
#' needed by `run_app()` to visualize the data with the `spatialLIBD` shiny
66
#' web application.
7+
#'
8+
#' This function wraps around [SpatialExperiment::read10xVisium()] and
9+
#' [spatialLIBD::spe_add_info()]. As the former is officially deprecated, one
10+
#' may opt to manually call functions from `VisiumIO`, such as `TENxVisium()`
11+
#' followed by `import()`, and then call `spe_add_info()` on the resulting
12+
#' [SpatialExperiment-class][SpatialExperiment::SpatialExperiment-class] object.
713
#'
814
#' @param samples Passed to [SpatialExperiment::read10xVisium()].
915
#' @param sample_id Passed to [SpatialExperiment::read10xVisium()].

man/read10xVisiumWrapper.Rd

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)