README.Rmd

---
output: github_document
---

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

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/"
)
```

# bossr <a href="https://pennsive.github.io/bossr/"><img src="man/figures/logo.png" align="right" height="139" /></a>

<!-- badges: start --
[![CRAN Status](https://www.r-pkg.org/badges/version/pkgdown)](https://cran.r-project.org/package=pkgdown){.pkgdown-release}
[![R-CMD-check](https://github.com/r-lib/pkgdown/workflows/R-CMD-check/badge.svg)](https://github.com/r-lib/pkgdown/actions){.pkgdown-devel}
[![Codecov test coverage](https://codecov.io/gh/r-lib/pkgdown/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/pkgdown?branch=main)
 badges: end -->


[![R-CMD-check](https://github.com/pennsive/bossr/workflows/R-CMD-check/badge.svg)](https://github.com/pennsive/bossr/actions?workflow=R-CMD-check)

`bossr` consists of functions for automated segmentation of oligodendrocytes in 2D, 3D and 4D arrays. 

## Installation

<!--
To install the released version:
```{r, eval = FALSE}
# Install released version from our drat repository
install.packages("bossr", repos='https://pennsive.github.io/drat')
```
-->
To install the development version:

```{r, eval=FALSE}
devtools::install_github('pennsive/bossr')
```

## Usage

For an introduction to the `bossr` pipeline, check out the [main article in our pkgdown site](https://pennsive.github.io/bossr/articles/bossr.html).

A companion data package, `bossrdata`, is available to enable users to follow along the examples in the main article. See the article for more information on how to install `bossrdata`.

References to the main functions can be found [here](https://pennsive.github.io/bossr/reference/index.html).

## Getting help

To get help [submit an issue on the GitHub repository](https://github.com/PennSIVE/bossr/issues).