---
title: "bmsma"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{bmsma}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

library(bmsma)
```

## Goal of package

## Installation

'bmsma' is under active development, you can install the development version of 'bmsma' from [GitHub](https://github.com/) with:

```{r, eval=FALSE}
# install.packages("remotes")
remotes::install_github("traitecoevo/bmsma")

library(bmsma)
```

## {bmsma} supported models

### Linear model

```{r example}
bmsma_model("ols") |>
  bmsma_assign_data(X = Loblolly$age,
                   Y = Loblolly$height,
                   N = nrow(Loblolly)) |>
  bmsma_run()
```
