search

amc-heme / scExploreR

Shiny app for single cell omics data visualization
https://amc-heme.github.io/scExploreR/
MIT License
3 stars 0 forks source link

Docs: clarify requirements for loading HDF5 SingleCellExperiment objects into the config app #328

Open wish1832 opened 1 month ago

wish1832 commented 1 month ago

I attempted to load a SCE object created with HDF5Array::saveHDF5SummarizedExperiment() into the config app, and forgot to set is_HDF5SummarizedExperiment to TRUE. The error message returned was confusing:

Error in scExploreR::run_config(object_path = "Triana_et_al_reference/Triana_et_al_sce/") : 
  No file extension detected for object at path Triana_et_al_reference/Triana_et_al_sce/. Please provide a path to an object with an extension of .rds or .h5ad.

A note to the documentation should be added to remind users to set is_HDF5SummarizedExperiment to TRUE. We might also want to modify the error message.

wish1832 commented 1 month ago

The docs were updated in 197bc1d. The error message can be modified later if users report confusion.