waldronlab / SingleCellMultiModal

Single Cell multimodal data scripts for downloading datasets
https://bioconductor.org/packages/SingleCellMultiModal
17 stars 9 forks source link

Provide context in vignettes #71

Open lwaldron opened 1 year ago

lwaldron commented 1 year ago

The vignettes would benefit a lot from addition of prose from the manuscript that provides context for what the dataset provides and how it can be used. For example, if someone is looking for a dataset where they could use one omics type for cell type identification and RNA-seq for differential expression analysis between cell types, you couldn't figure out what might be an appropriate dataset from the documentation which currently focuses just on outputs of R commands. This documentation enhancement could be made just by copying relevant parts of the manuscript into the vignette of each dataset, and citing the manuscript. @kbeckenrode do you think you could take this on and submit a PR?

lwaldron commented 1 year ago

Ideally this would also include the table for each dataset, translated into Markdown (e.g. using one of the Markdown table generators), as well as the cell filtering and annotations information from Table 9.