lcolladotor
commented
2 years ago First create a script using usethis::use_data_raw(). There you'll import any (large) file you want, then subset it to make it as small as possible such that your examples make sense but that your package is under the 5 mb limit. So like, you might make an rse object that just has data for 100 genes across say 10 samples. Something like that. You can check the file size using lobstr::obj_size(). If you want the size in Mb use lobstr::obj_size() / 1024^2. Once you are happy with how small the data is, then save it using usethis::use_data() inside the R script you generated with usethis::use_data_raw().
Here are two such examples:
- https://github.com/LieberInstitute/spatialLIBD/blob/master/data-raw/asd_sfari_geneList.R where I reshape some data, then even test that it works with my functions.
- https://github.com/LieberInstitute/spatialLIBD/blob/master/data-raw/create_sce_example.R where I subset an
sceobject. Back then,pryr::object_size()used to be the function for check memory size, but now it'slobstr::obj_size().
In that last example, the final object was still quite big, but well, that's why I ended up sharing the data through ExperimentHub http://bioconductor.org/packages/release/bioc/html/ExperimentHub.html. That's the solution if you need a large example file for your code to work. That route involves going through http://bioconductor.org/packages/release/bioc/vignettes/HubPub/inst/doc/CreateAHubPackage.html and you want to avoid this as much as possible. Another solution is to use some already publicly available data from AnnotationHub/ExperimentHub or other packages like http://bioconductor.org/packages/release/data/experiment/html/scRNAseq.html https://github.com/lmweber/STexampleData, https://github.com/helenalc/TENxVisiumData.
https://usethis.r-lib.org/reference/use_data.html
@lahuuki: this also applies to DeconvoBuddies and other packages.
joshstolz
will need help making the data in
data/available to the package so that the examples work.