Skip to content

Submission Process

Paul Hoffman edited this page Aug 6, 2019 · 4 revisions

How to submit a new wrapper

  1. Fork the SeuratWrappers GitHub repository

  2. Create a new file in the R/ directory with a name that corresponds to the method/package being submitted (eg. fast_mnn.R)

  3. Add the wrapper code to the new R file. See here for code guidelines

  4. Create a vignette showcasing your method on a Seurat object using Rmarkdown. The RMD file should be placed in the docs/ directory. See here for vignette guidelines

  5. Submit a pull request to the SeuratWrappers GitHub repository. This will automatically trigger a continuous integration build to ensure the vignette builds successfully