Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
^.*\.Rproj$
^\.Rproj\.user$
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.Rproj.user
.Rhistory
.RData
.Ruserdata
1 change: 1 addition & 0 deletions R/availableOSN.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#' use 'paws::s3' to interrogate an NSF Open Storage Network
#' bucket for zipped zarr archives for various platforms
#' @examples
#' Sys.setenv(AWS_REGION = "us-east-1")
#' if (requireNamespace("paws")) {
#' availableOSN()
#' }
Expand Down
1 change: 0 additions & 1 deletion R/get_demo_SD.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
# # the following are equivalent:
# get_demo_SD("merfish")
# MouseBrainMERFISH()
#
.get_demo_SD <- function(patt,
cache=BiocFileCache::BiocFileCache(),
target=tempfile()) {
Expand Down
43 changes: 30 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,25 @@ installed; it is not necessary for retrievals.
**Query Bioconductor's OSN bucket:**

```
> available_spd_zarr_zips() # as of Nov 10 2024
> Sys.setenv(AWS_REGION = "us-east-1")
> availableOSN() # as of May 19 2025
checking Bioconductor OSN bucket...
[1] "mcmicro_io.zip"
[2] "merfish.zarr.zip"
[3] "mibitof.zip"
[4] "steinbock_io.zip"
[5] "visium_associated_xenium_io_aligned.zip"
[6] "visium_hd_3.0.0_io.zip"
[1] "HuLungXenmulti.zip"
[2] "mcmicro_io.zip"
[3] "merfish.zarr.zip"
[4] "mibitof.zip"
[5] "steinbock_io.zip"
[6] "visium_associated_xenium_io_aligned.zip"
[7] "visium_hd_3.0.0_io.zip"
[8] "xenium_rep1_io_aligned.zip"
[9] "xenium_rep2_io_aligned.zip"
```

**Bring a *.zip* archive into your local cache:**

```
dir.create(tf <- tempfile())
pa = unzip_spd_demo(
pa = SpatialData.data:::.unzip_spd_demo(
zipname="mibitof.zip",
destination=tf,
source="biocOSN")
Expand All @@ -51,16 +55,29 @@ dir(pa, full.names=TRUE) # see the files

```
(mibi <- readSpatialData(pa))
# or simply
# (mibi <- ColorectalCarcinomaMIBITOF())
```

```
> mibi
class: SpatialData
images(3): point16_image point23_image point8_image
labels(3): point16_labels point23_labels point8_labels
shapes(0):
points(0):
tables(1): table
- images(3):
- point16_image (3,1024,1024)
- point23_image (3,1024,1024)
- point8_image (3,1024,1024)
- labels(3):
- point16_labels (1024,1024)
- point23_labels (1024,1024)
- point8_labels (1024,1024)
- points(0):
- shapes(0):
- tables(1):
- table (36,3309)
coordinate systems:
- point16(2): point16_image point16_labels
- point23(2): point23_image point23_labels
- point8(2): point8_image point8_labels
```

```
Expand Down
18 changes: 18 additions & 0 deletions SpatialData.data.Rproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Version: 1.0
ProjectId: 0a801e22-89ff-4b2c-936c-66149f25bd86

RestoreWorkspace: Default
SaveWorkspace: Default
AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
LaTeX: pdfLaTeX

BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
1 change: 1 addition & 0 deletions man/availableOSN.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions tests/testthat/test-caching.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
library(SpatialData)
Sys.setenv(AWS_REGION = "us-east-1")

test_that("available_sdio()", {
expect_error(available_sdio(1))
Expand Down
1 change: 1 addition & 0 deletions vignettes/SpatialData.data.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ and can be retrieved with caching support using `r BiocStyle::Biocpkg("BiocFileC
We can interrogate the bucket for available (zipped) .zarr archives:

```{r ons-list}
Sys.setenv(AWS_REGION = "us-east-1")
if (requireNamespace("paws")) availableOSN()
```

Expand Down