---
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 = file.path("man", "figures", "README-"),
  out.width = "100%"
)
```

<!-- badges: start -->
[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![License](https://img.shields.io/badge/license-GPL--3-blue.svg?style=flat)](https://www.gnu.org/licenses/gpl-3.0.html)
[![Release](https://img.shields.io/github/release/inbo/neuroatlas.svg)](https://github.com/inbo/neuroatlas/releases)
![GitHub](https://img.shields.io/github/license/inbo/neuroatlas)
[![R build status](https://github.com/inbo/neuroatlas/workflows/check%20package%20on%20main/badge.svg)](https://github.com/inbo/neuroatlas/actions)
![r-universe name](https://inbo.r-universe.dev/badges/:name?color=c04384)
![r-universe package](https://inbo.r-universe.dev/badges/neuroatlas)
[![Codecov test coverage](https://codecov.io/gh/inbo/neuroatlas/branch/main/graph/badge.svg)](https://app.codecov.io/gh/inbo/neuroatlas?branch=main)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/inbo/neuroatlas.svg)
![GitHub repo size](https://img.shields.io/github/repo-size/inbo/neuroatlas.svg)
<!-- badges: end -->

# neuroatlas

The goal of neuroatlas is to ...

## Installation

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

``` r
# install.packages("remotes")
remotes::install_github("inbo/neuroatlas")
```

## Example

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

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

What is special about using `README.Rmd` instead of just `README.md`? 
You can include R chunks like so:

```{r cars}
summary(cars)
```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date.
`devtools::build_readme()` is handy for this.

You can also embed plots, for example:

```{r pressure, echo = FALSE, eval = FALSE}
plot(pressure)
```

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.