README.md

In daskelly/earlycross: Extensions to Seurat

earlycross -- extension functions to Seurat

This package was previously named Signac. However, there is another package named Signac that is used for analyzing single cell ATAC-Seq data available here. Thus, I have renamed this package earlycross which is an allusion to the (earlier) art of Cross.

Installing the package

devtools::install_github("daskelly/earlycross")

Building the package

Here are two helpful links that I used when building this package: 1. https://hilaryparker.com/2014/04/29/writing-an-r-package-from-scratch/ 2. http://kbroman.org/pkg_primer/

library(devtools)
library(roxygen2)

setwd("~/repos")
create("earlycross")
# manually add functions ...
# ...
devtools::use_package("Seurat", "Imports")
devtools::use_package("assertthat", "Imports")
devtools::use_package("Matrix", "Imports")
setwd('./earlycross')
document()

When coming back to add new functions:

# Add functions to R/
# When referring to internal functions no need for :: or :::
# rm -f NAMESPACE
library(devtools)
document()

When working on the package locally you can install it by:

setwd("~/repos/earlycross")
library(devtools)
build()
install()

Two easy methods to keep code tidy and well-formatted:

formatR::tidy_dir("R")
lintr::lint_package()

See here.

daskelly/earlycross documentation built on Feb. 20, 2023, 3:56 p.m.