README.md

nat: NeuroAnatomy Toolbox

DOI Release Version CRAN_Status_Badge Build Status Coverage Status Docs

An R package for the (3D) visualisation and analysis of biological image data, especially tracings of single neurons. nat is the core package of a wider suite of neuroanatomy tools introduced at http://jefferislab.github.io. nat (and its ancestors) have been used in a number of papers from our group including:

Cell 2007 Cover CB 2010 Cover Nature 2011 Cell 2013 Abstract Neuron 2016

Quick Start

For the impatient ...

# install
install.packages("nat")
# use
library(nat)

# plot some test data (?kcs20 for details)
# Drosophila Kenyon cells processed from raw data at http://flycircuit.tw
head(kcs20)
open3d()
plot3d(kcs20, col=type)
# get help
?nat

Installation

A confirmed stable version of nat can be installed from CRAN.

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

However, **nat** remains under quite active development, so if you will be 
using **nat** extensively, we generally
recommend installing the latest development version directly from github using
the [devtools](https://cran.r-project.org/package=devtools) package.

```r
# install devtools if required
if (!requireNamespace("devtools")) install.packages("devtools")
# then install nat
devtools::install_github("jefferis/nat")

Learn

To get an idea of what nat can do:

When you're ready to learn more:

Help

If you want some help using nat:

If you think that you have found a bug:

Thanks for your interest in nat!



jefferis/nat documentation built on Sept. 29, 2018, 5:22 p.m.