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%"
)
```
# boral: Bayesian Ordination and Regression AnaLysis

<!-- badges: start -->
[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
[![CRAN status](https://www.r-pkg.org/badges/version/boral)](https://cran.r-project.org/package=boral)
<!-- badges: end -->

The `boral` R-package fits Bayesian approaches for analyzing multivariate data in ecology. Estimation is performed using Markov Chain Monte Carlo (MCMC) methods via Three. JAGS types of models may be fitted: 

1) With explanatory variables only, boral fits independent column Generalized Linear Models (GLMs) to each column of the response matrix; 
2) With latent variables only, boral fits a purely latent variable model for model-based unconstrained ordination; 
3) With explanatory and latent variables, boral fits correlated column GLMs with latent variables to account for any residual correlation between the columns of the response matrix. 


## Installation

You can install the released version of boral from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("boral")
```

<!-- And the development version from [GitHub](https://github.com/) with: -->

<!-- ``` r -->
<!-- # install.packages("devtools") -->
<!-- devtools::install_github("emitanaka/boral") -->
<!-- ``` -->