crispyr

crispyr is intended as a collection of wrappers for CRISPR-Cas9 analysis.

Right now it is very much in early development and I’m using it primarily for internal use and to get familiar with package building.

Installation

You couldn install the development version of crispyr from GitHub with:

# install.packages("pak")
pak::pak("StrawHattM/crispyr")

or

# install.packages("devtools")
devtools::install_github("StrawHattM/crispyr")

but it’s probably not going to do much for you

Example

This is a basic example which shows you how to solve a common problem:

library(crispyr)
## basic example code

What is special about using README.Rmd instead of just README.md? You can include R chunks like so:

summary(cars)
#>      speed           dist       
#>  Min.   : 4.0   Min.   :  2.00  
#>  1st Qu.:12.0   1st Qu.: 26.00  
#>  Median :15.0   Median : 36.00  
#>  Mean   :15.4   Mean   : 42.98  
#>  3rd Qu.:19.0   3rd Qu.: 56.00  
#>  Max.   :25.0   Max.   :120.00

You’ll still need to render README.Rmd regularly, to keep README.md up-to-date. devtools::build_readme() is handy for this.

You can also embed plots, for example:

In that case, don’t forget to commit and push the resulting figure files, so they display on GitHub and CRAN.