Provide context in vignettes
@kbeckenrode is already working on this.
Since Jul 4, 2023.
Assessment
This issue has not been assessed yet.
Description
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?
- seqFISH.Rmd
- SCoPE2.Rmd
- ECCITEseq.Rmd
- scMultiome.Rmd
- GTseq.Rmd
- scNMT.Rmd
- CITEseq.Rmd
- Dominant language
- R
- Stars
- 20
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
easystats/performance#950 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
briandconnelly/airnow#9 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
OHDSI/CohortConstructor#774 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100