README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# MOSuite

<!-- badges: start -->

[![R-CMD-check](https://github.com/CCBR/MOSuite/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/CCBR/MOSuite/actions/workflows/R-CMD-check.yaml)

<!-- badges: end -->

R package for downstream multi-omics analysis

Designed for differential [RNA-seq](https://github.com/CCBR/RENEE) analysis
or any data represented in a counts table.
See the website for more information, documentation, and examples:
<https://ccbr.github.io/MOSuite/>

## Installation

You can install the development version of MOSuite from [GitHub](https://github.com/CCBR/MOSuite) with:

```r
# install.packages("devtools")
devtools::install_github("CCBR/MOSuite")
```

## Usage

Please see the [introductory vignette](https://ccbr.github.io/MOSuite/articles/intro.html)
for a quick start tutorial.
Take a look at the [reference documentation](https://ccbr.github.io/MOSuite/reference/index.html)
for detailed information on each function in the package.

<!--
## Example

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

```{r example, message=FALSE, warning=FALSE}
library(MOSuite)
## basic example code
```
-->

## Help & Contributing

Come across a **bug**? Open an [issue](https://github.com/CCBR/MOSuite/issues) and include a minimal reproducible example.

Have a **question**? Ask it in [discussions](https://github.com/CCBR/MOSuite/discussions).

Want to **contribute** to this project? Check out the [contributing guidelines](.github/CONTRIBUTING.md).

## Development Roadmap

![](./man/figures/development-plan.png)

- [dev spreadsheet](https://nih-my.sharepoint.com/:x:/g/personal/homanpj_nih_gov/ETvHXgnwxExEpcP57Jj9_EwBHBvZBqNuZ_c3eu51w-SlnA?e=PcXKU8)
- [project board](https://github.com/orgs/CCBR/projects/32)