Home

SeuratWrappers Contribution Guide

Thank you for your interest in adding a new method to SeuratWrappers! We encourage you to read through the guidelines listed in the sidebar on the right-hand side of the page to figure out how to get your method submitted to SeuratWrappers.

Basic Requirements

Before submitting a pull request to SeuratWrappers, please follow these guidelines:

• All required code is contained within an R package that is easily installed and accessible, such as GitHub, CRAN, or Bioconductor. We do not require that the package is available on CRAN or Bioconductor but highly recommend package developers consider submitting to one of those repositories

  NOTE: this does not require a new R package for a method; if your method uses functions found in standard R packages, those count as easily installable (see ALRA on SeuratWrappers as an example)

• At least one vignette provided as an Rmarkdown file demonstrating how to use the method on a Seurat object
• A citable reference for the method provided; this can be either a published paper or a preprint