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%"
)
```

# tractable <img src="man/figures/tractable_logo.png" align="right" height="139"/>

<!-- badges: start -->

<!--insert CRAN status badge -->

[![R-CMD-check](https://github.com/tractometry/tractable/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tractometry/tractable/actions/workflows/R-CMD-check.yaml) [![Codecov test coverage](https://codecov.io/gh/tractometry/tractable/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tractometry/tractable?branch=main)

<!-- badges: end -->

## Overview

tractable contains functions to analyze diffusion MRI (dMRI) tract profiles using generalized additive models. It operates on outputs from the AFQ software ecosystem and tests for differences between two phenotypic groups along the length of a specified white matter tract.

## Installation

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

``` r
# install.packages("devtools")
devtools::install_github("tractometry/tractable")
```

## Example

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

```{r example}
library(tractable)
## basic example code
```

## Code of Conduct

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