# nat.templatebrains

## Quick Start

For the impatient …

```
# install
install.packages("nat.templatebrains")
# use
library(nat.templatebrains)
# basic examples for templatebrain class
example("as.templatebrain")
example("templatebrain-meths")
# run examples for mirroring
example("mirror_brain")
# ... and bridging
# NB you need to install nat.flybrains package to run some examples which are
# not run by default
example("xform_brain")
# get overview help for package
?nat.templatebrains
# help for main functions
?mirror_brain
?xform_brain
# if you want to construct your own templatebrains
?templatebrain
# run tests
library(testthat)
test_package("nat.templatebrains")
```

**nat.templatebrains** provides additional functions for
use with the NeuroAnatomy
Toolbox (nat). In particular, it defines the notion of a template
brain, as used in image registration of 3D data, along with bridging
registrations between template brains (see
https://github.com/jefferislab/BridgingRegistrations) and mirroring
registrations from one brain hemisphere to the other.

This is a generic package, usable with data from any species. For
*Drosophila* specific functions and data, see our nat.flybrains
package. Installing/loading **nat.flybrains** will
automatically install/load **nat.templatebrains**.

## Installation

This package has now been released to CRAN (since v0.4.1), but since
there are regular updates between CRAN releases we generally recommend
that you install the development version from GitHub.

### CRAN release

`install.packages("nat.templatebrains")`

### Development version

If you want to install the development version of nat.templatebrains,
you can do this using devtools. You will probably also wish to install
the development version of the nat package if you do this.

```
if (!require("remotes")) install.packages("remotes")
remotes::install_github("natverse/nat")
remotes::install_github("natverse/nat.templatebrains")
```

Note: Windows users may need Rtools as well as
remotes to
install this way.