Skip to content

Provide context in vignettes #71

Description

@lwaldron

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions