README.Rmd

# Microbiome time series manipulation with miaTime <img src="man/figures/mia_logo.png" align="right" width="120" />

<!-- badges: start -->

[![R-CMD-check-bioc-devel](https://github.com/microbiome/miaTime/workflows/R-CMD-check-bioc-devel/badge.svg)](https://github.com/microbiome/miaTime/actions)
<!--[![R-CMD-check-bioc](https://github.com/microbiome/mia/actions/workflows/check-bioc.yml/badge.svg)](https://github.com/microbiome/mia/actions/workflows/check-bioc.yml)-->
[![Codecov test
coverage](https://codecov.io/gh/microbiome/miaTime/branch/master/graph/badge.svg)](https://codecov.io/gh/microbiome/miaTime?branch=master)

<!-- badges: end -->

# miaTime

This R package can be used to analyse time series data for microbial
communities. The package is part of [miaverse](https://microbiome.github.io/), 
and is based on the `TreeSummarizedExperiment` data container.

See the [package homepage](https://microbiome.github.io/miaTime) for
example workflows.

## Installation
 
The package can be directly installed from R command line.

```{r, eval=FALSE, message=FALSE}
devtools::install_github("microbiome/miaTime")
library(miaTime)
```

### Contributions and acknowledgments

You can find us online from [Gitter](https://gitter.im/microbiome/miaverse).

Contributions are very welcome through issues and pull requests at the
[development site](https://github.com/microbiome/miaTime). We follow a git
flow kind of approach. Development version should be done against the
`main` branch and then merged to `release` for release.
(https://guides.github.com/introduction/flow/)

**Kindly cite this work**. For citation details, see R command
```{r}
citation("miaTime")  
```

# Code of conduct

The project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.