Repository files navigation

An R package for the (3D) visualisation and analysis of biological image data, especially tracings ofsingle neurons.nat is the core package of a wider suite of neuroanatomytools introduced athttp://natverse.github.io.nat (and itsancestors)have been used in a number of papers from our group including:

For the impatient ...

# installinstall.packages("nat")# uselibrary(nat)# plot some test data (?kcs20 for details)# Drosophila Kenyon cells processed from raw data formerly available at# flycircuit.twhead(kcs20)open3d()plot3d(kcs20,col=type)# get help?nat

A confirmed stable version ofnat can be installed from CRAN.

install.packages("nat")

However,nat remains under quite active development, so if you will beusingnat extensively, we generallyrecommend installing the latest development version directly from github usingthedevtools package.

# install devtools if requiredif (!requireNamespace("devtools")) install.packages("devtools")# then install natdevtools::install_github("natverse/nat")

To get an idea of whatnat can do:

• Skim through the Articles listed athttps://natverse.org//nat/
• Take a look at theR Markdown reports usedto generate thefigures for our NBLAST paper.

When you're ready to learn more:

• Read theoverview package documentation(?nat in R)
• Read theIntroduction to neurons article
• Check out the thematically organisedfunction reference documentation.
  • Most help pages include examples.
• Try out sample code:
  • nat.examples has detailedexamples for data sets from a range of model organisms and techniques
  • frulhns analysis of sexually dimorphic circuits
  • NBLAST figures

If you want some help usingnat:

• For installation issues, see theInstallation vignette
• Contactnat-user Google group -we normally respond promptly and you will also be helping future users.

If you think that you have found a bug:

• Install the development version of nat using devtools (see above) and see ifthat helps.
• Check thegithub issues and
  • file a bug report if this seems to be a new problem
  • comment on an existing bug report

Thanks for your interest innat!