rosace

Overview

rosace is an R package for analyzing growth-based deep mutational scanning screen data.

Installation

rosace uses cmdstanr to run inference. Please ensure that cmdstanr is properly installed before installing rosace. Below is a concise installation command; for complete details, please refer to the official website.

install.packages("cmdstanr", repos = c("https://mc-stan.org/r-packages/", getOption("repos")))

# use cmdstanr to install CmdStan, this requires a working C++ toolchain and compiler
library(cmdstanr)
install_cmdstan(cores = 4)

To install rosace start R and first install devtools by typing

install.packages("devtools")

and install rosace by typing

devtools::install_github("pimentellab/rosace")

If you prefer to use Docker, we also provide a Docker image for rosace. You can pull the image in the command line with

docker pull cbmacdo/rosace-docker

See the full Installation Instructions for further details and alternative installation options.

Getting started

library("rosace")

We recommend starting with the vignette. A vignette for the simulation module Rosette is also avaliable.

Further help

You may submit a bug report here on GitHub as an issue or you could send an email to roserao@ucla.edu.

Citing rosace

Please cite the following publication if you use rosace: xxxxxx