This vignette is designed to give you a good introduction to some of the key features of nat by teaching you about how it handles individual neurons and collections of neurons.
The source code for this vignette is available at https://github.com/natverse/nat/blob/master/vignettes/neurons-intro.Rmd. If you find something unclear or notice a typo, I would be very happy if you would click on the Pencil Icon on that page or follow this link to edit and suggest an alternative wording. Don’t be shy about doing this; I have to review any change and even if your suggestion is not perfect it will still be a prompt for me to improve this document. Thank you!
Install the package if required
install.packages('nat', dependencies = TRUE)
Load the package
There are a number of basic built in types of data in R such as vectors and matrices, but it is also very easy to define new data types with specialised features to enable powerful and efficient analysis of particular kinds of data. These specialised data types are called classes and a specific instance of a class is an object (a neuroscience analogy: this is the difference between talking about the general class of mitral cells and the specific cell that you just sealed onto with your patch clamp electrode.)
We will look at two key classes that nat defines for handling 3D structures of neurons
As an example we’re going to look at a data set of olfactory projection neurons originally published as Supplemental Information to accompany Jefferis, Potter et al, Cell (2007). A subset of the original data are distributed as a sample data object with the nat package, which we can load like so.
For more information about these data see Cell07PNs.
Cell07PNs object has two classes
neuronlist and the base class
##  "neuronlist" "list"
Many R objects inherit from the base class
list (objects can have multiple classes in the same way that a mitral cell is also neuron) because this is a convenient container class into which you can put a variety of different kinds of data. In this case the
neuronlist contains 40 objects:
##  40
# access the first neuron in the neuronlist class(Cell07PNs[])
##  "neuron" "list"
each representing a traced neuron. We will now look in detail at these two classes.
We start by extracting the first neuron in Cell07PNs, and assigning it to a variable. We can then plot the neuron so that we have an image of what we are talking about.
str function (short for structure) allows us to take a look at the internal structure of this neuron object.
# Use =1 so that we don't show complete structure # for objects inside n1 str(n1, max.level=1)
## List of 24 ## $ CellType : chr "DA1" ## $ NeuronName : chr "EBH11R" ## $ InputFileName: 'AsIs' chr "/GD/projects/PN2/TransformedTraces/DA1/EBH11R.tasc" ## $ CreatedAt : POSIXt[1:1], format: "2006-01-17 15:21:14" ## $ NodeName : Named chr "jefferis.joh.cam.ac.uk" ## ..- attr(*, "names")= chr "nodename" ## $ InputFileStat:'data.frame': 1 obs. of 10 variables: ## $ InputFileMD5 : Named chr "fcacee3f874cbe2c6ad96214e6fee337" ## ..- attr(*, "names")= 'AsIs' chr "/GD/projects/PN2/TransformedTraces/DA1/EBH11R.tasc" ## $ NumPoints : int 180 ## $ StartPoint : num 1 ## $ BranchPoints : num [1:16] 34 48 51 75 78 95 98 99 108 109 ... ## $ EndPoints : num [1:18] 1 42 59 62 80 85 96 100 102 112 ... ## $ NumSegs : int 33 ## $ SegList :List of 33 ## $ d :'data.frame': 180 obs. of 7 variables: ## $ OrientInfo :List of 5 ## $ SegOrders : num [1:33] 1 2 2 3 4 4 3 4 5 5 ... ## $ MBPoints : int [1:2] 34 48 ## $ LHBranchPoint: int 75 ## $ SegTypes : num [1:33] 1 3 1 3 3 3 1 2 2 2 ... ## $ AxonSegNos :List of 3 ## $ LHSegNos : num [1:26] 8 9 10 11 12 13 14 15 16 17 ... ## $ MBSegNos :List of 2 ## $ NumMBBranches: num 2 ## $ AxonLHEP : num 72 ## - attr(*, "class")= chr [1:2] "neuron" "list"
##  180
##  180
There are a set of core fields (described in
?neuron documentation); the key ones will be described shortly. However there are also quite a few user fields in this neuron and you can safely add any field you like so long as its name does not clash with an existing field. For example:
n1$Comment='The sex of this specimen is uncertain'
The single most important field in a neuron is the
data.frame. This contains a block of data closely reminiscent of the SWC data format for traced neurons:
## 'data.frame': 180 obs. of 7 variables: ## $ PointNo: int 1 2 3 4 5 6 7 8 9 10 ... ## $ Label : num 2 2 2 2 2 2 2 2 2 2 ... ## $ X : num 187 187 188 188 188 ... ## $ Y : num 133 131 130 129 129 ... ## $ Z : num 88.2 90.6 93.1 95 97.5 ... ## $ W : num 1.01 1.27 1.14 1.27 1.27 1.27 1.27 1.27 1.27 1.27 ... ## $ Parent : num -1 1 2 3 4 5 6 7 8 9 ...
Each row defines a node in a branched tree with a unique integer identifier,
PointNo, normally but not always sequentially numbered from 1. The
X,Y,Z columns encode the position of each vertex and the
W column encodes the diameter of the neurite at that position.
R’s simple S3 object oriented system allows specialised functions for particular classes to be defined. These functions tailored to a particular class are called methods. Methods can be provided for pre-existing functions supplied with base R as well as new user-written functions. The system is quite simple. If a function
foo is defined as a generic function then you can define new functions called
foo.bar that will be called when you write
x has class
We already used one such method without comment,
plot.neuron. There is a base R function called
plot. nat defines a new function called
plot.neuron, which R interprets as a
plot method specialised for
neuron objects. When the base R
plot function is called, it looks at the class of its first object to see whether a specialised method exists. If there is none, it will use a fallback method called
plot.neuron method interprets the branching structure of a neuron and draws line segments joining up the connected nodes at the appropriate 2D positions. You can compare it with what you would get if you just plotted the XY position of all nodes joined together by a single line:
plot(n1$d$X, n1$d$Y, type = 'l')
You can find out what methods are available for a particular class like so:
methods(class = 'neuron')
##  all.equal as.neuron as.ngraph as.seglist ##  branchpoints dotprops endpoints intersect_plane ##  ndigest nvertices Ops plot ##  plot3d potential_synapses print prune_in_volume ##  prune_online prune_twigs prune resample ##  rootpoints scale sholl_analysis subset ##  summary write.vtk xform xyzmatrix ##  xyzmatrix<- ## see '?methods' for accessing help and source code
It is also good idea to look at nat’s function reference page which groups available functions into categories that often reflect the class of object they can work on.
In R, operators such as
+ are actually special functions with two arguments, so one can add methods for these in the same way. In the following example we use this arithmetic to shift a neuron by a small amount:
Another specialised method is
subset.neuron which we can use to extract part of a neuron into a new object. For example, a simple spatial criterion, X location must be >240, is used to extract the axon terminal arborisation field in this example
We can also summarise the morphological properties of a neuron using the
summary.neuron method, which allows us to compare measurements for the original neuron and the axon arbour that we just cut out above.
## root nodes segments branchpoints endpoints cable.length ## 1 1 180 33 16 18 297.1763
## root nodes segments branchpoints endpoints cable.length ## 1 1 111 27 13 15 156.7654
See nat’s function reference page for additional functions for working with neurons.
data statement above loaded a
neuronlist object called
Cell07PNs containing 40
neuronlist objects are key data structures in nat for convenient handling of collections of neurons.
The diagram above presents the structure of a neuronlist,
x, which contains 5 neurons. The main structure is an R
list object, which in this case contains 5 slots. Each slot contains a neuron with a unique name. In addition to this list of neurons there is an optional attached
data.frame (another standard R class). When present, each neuron in the main list must have a matching row in this
Neuronlists can be manipulated use the square bracket subscript operator to extract or replace a subset of their elements. Crucially when this happens the corresponding rows of the attached metadata are also selected as diagrammed for the result of x[1:3] (right hand side of figure above).
When subscripting any list in R, it is very important to understand the difference between using the single and double bracket operator. We can illustrate this difference as follows:
The single bracket operator makes a new list containing a specified subset of elements in the original list, while the double bracket operator extracts the object at the given position. So in the figure
x is a
neuronlist object of length 1, whereas
x[] is the
neuron object at the first position in the list.
## 'neuronlist' containing 40 'neuron' objects and 'data.frame' with 27 vars [4.4 MB]
A length 1
## 'neuronlist' containing 1 'neuron' object and 'data.frame' with 27 vars [51.1 kB]
The first element, a
## 'neuron' with 180 vertices in 1 tree
Let us start by extracting the first five neurons from our sample data.
# we can select neurons by indexing first5=Cell07PNs[1:5] summary(first5)
## root nodes segments branchpoints endpoints cable.length ## EBH11R 1 180 33 16 18 297.1763 ## EBH20L 1 200 26 12 15 327.0929 ## EBH20R 1 199 25 12 14 347.6153 ## EBI12L 1 169 23 11 13 294.4680 ## EBI22R 1 160 27 13 15 303.0150
Each neuron in the neuronlist has an associated name which can be used to select it. We can get the names of all neurons using the
##  "EBH11R" "EBH20L" "EBH20R" "EBI12L" "EBI22R" "EBJ23L" "EBJ3R" "EBN19L" ##  "EBO15L" "EBO53L" "ECA34L" "ECB3L" "LI23L" "LIC2R" "LJ5L" "MC3B" ##  "MH16L" "MM14L" "NA7L" "NH15L" "NH29B" "NI16L" "NIA8L" "NIA8R" ##  "NNA9L" "NNC4R" "NNE1L" "OFD2L" "OKC9R" "SDD8L" "SH21L" "SL20L" ##  "TKC8R" "TL4R" "TS7L" "TT27R" "VA15R" "VA20R" "VB37L" "VB58L"
##  TRUE
You can also use the
$ operator to access a single neuron e.g.
Cell07PNs$EBH11R. This can be quite useful when working interactively in the console because RStudio will offer to autocomplete the neuron name when you start typing past the
$ symbol, but is not recommended for scripts.
The names of neurons are also used to index a
data.frame object attached to the neuronlist with one row for each neuron. You can use the
head function to give a summary of the attached metadata in this neuronlist. Using the
as.data.frame method on a neuronlist allows you to extract this attached metadata to a separate object.
## Brain RegistrationScore Notes Glomerulus Batch Directory Traced ## EBH11R EBH11R 4 DA1 PN2 unsure yes ## EBH20L EBH20L 4 DL3 PN2 unsure2 yes ## EBH20R EBH20R 4 DA1 PN2 unsure2 yes ## EBI12L EBI12L 4 DA1 PN2 unsure3 yes ## EBI22R EBI22R 4 DL3 PN2 unsure3 yes ## EBJ23L EBJ23L 4 DL3 PN2 unsure4 yes ## Scored.By Sex Include ID HaveWarp HaveAsc ## EBH11R ACH M EBH11R TRUE TRUE ## EBH20L ACH EBH20L TRUE TRUE ## EBH20R ACH M EBH20R TRUE TRUE ## EBI12L ACH F EBI12L TRUE TRUE ## EBI22R ACH EBI22R TRUE TRUE ## EBJ23L ACH EBJ23L TRUE TRUE ## TraceFile AscBatch Status ## EBH11R /GD/projects/PN2/TransformedTraces/DA1/EBH11R.tasc New ## EBH20L /GD/projects/PN2/TransformedTraces/DL3/EBH20L.tasc New ## EBH20R /GD/projects/PN2/TransformedTraces/DA1/EBH20R.tasc New ## EBI12L /GD/projects/PN2/TransformedTraces/DA1/EBI12L.tasc New ## EBI22R /GD/projects/PN2/TransformedTraces/DL3/EBI22R.tasc New ## EBJ23L /GD/projects/PN2/TransformedTraces/DL3/EBJ23L.tasc New ## GlomSeq NumNAs MBP1 MBP2 LHBP PNType Seq nTrees StartPoint ## EBH11R 1 0 34 48 75 iPN 13 1 1 ## EBH20L 1 0 29 29 77 iPN 15 1 1 ## EBH20R 2 0 24 80 147 iPN 16 1 1 ## EBI12L 3 0 29 59 89 iPN 18 1 1 ## EBI22R 2 0 34 34 56 iPN 20 1 1 ## EBJ23L 3 0 23 23 52 iPN 21 1 1 ## CreatedAt ## EBH11R 2006-01-17 15:21:14 ## EBH20L 2006-01-17 15:21:14 ## EBH20R 2006-01-17 15:21:14 ## EBI12L 2006-01-17 15:21:15 ## EBI22R 2006-01-17 15:21:15 ## EBJ23L 2006-01-17 15:21:15 ## WarpFile ## EBH11R /GD/projects/PN2/allreg/warp/unsure/average-goodbrains_EBH11R101_warp_m0g40c4e1e-1x16r3.list ## EBH20L /GD/projects/PN2/allreg/warp/unsure2/average-goodbrains_EBH20L101_warp_m0g40c4e1e-1x16r3.list ## EBH20R /GD/projects/PN2/allreg/warp/unsure2/average-goodbrains_EBH20R101_warp_m0g40c4e1e-1x16r3.list ## EBI12L /GD/projects/PN2/allreg/warp/unsure3/average-goodbrains_EBI12L101_warp_m0g40c4e1e-1x16r3.list ## EBI22R /GD/projects/PN2/allreg/warp/unsure3/average-goodbrains_EBI22R101_warp_m0g40c4e1e-1x16r3.list ## EBJ23L /GD/projects/PN2/allreg/warp/unsure4/average-goodbrains_EBJ23L101_warp_m0g40c4e1e-1x16r3.list
##  40
##  TRUE
You can use columns in the attached metadata in expressions that select or operate on the neurons in the list. In the next two examples we
subsetthe neurons in a neuronlist based on a metadata column
withfunction to carry out a calculation using column(s) of metadata.
## Glomerulus ## DA1 DL3 DP1m VA1d ## 11 10 8 11
There is a second approach to accessing this attached metadata data.frame, using the square bracket operator with two arguments as used for subscripting (2D) matrices or
data.frames. For example we can access the
Glomerulus column like so:
##  DA1 DL3 DA1 DA1 DL3 DL3 VA1d VA1d VA1d VA1d DP1m DP1m DA1 DL3 VA1d ##  VA1d DL3 DA1 DA1 VA1d VA1d VA1d DL3 VA1d DP1m DP1m DP1m DP1m DP1m DP1m ##  DA1 DL3 DL3 DL3 VA1d DA1 DA1 DA1 DL3 DA1 ## Levels: DA1 DL3 DP1m VA1d
This approach has some features that make for additional flexibility. For example you can access the whole data.frame like so:
[,] which includes a comma implies two (missing) arguments. nat therefore interprets this as request for the 2D data.frame attached to Cell07PNs rather than the neuronlist itself. You can also use this notation to add new columns or modify existing columns in place.
You can also access selected rows of the data.frame in the normal way:
Cell07PNs[1:5, "Glomerulus"] Cell07PNs[Cell07PNs[, "Sex"]=="F", "Glomerulus"]
There are quite a few methods defined for the
methods(class = "neuronlist")
##  - [ [<- * ##  / + as.data.frame as.neuronlistfh ##  c data.frame<- dimnames dotprops ##  droplevels head intersect mirror ##  nvertices plot plot3d potential_synapses ##  print prune_in_volume prune_online prune_twigs ##  prune resample setdiff sholl_analysis ##  subset summary tail union ##  with xform xyzmatrix xyzmatrix<- ## see '?methods' for accessing help and source code
For example we can scale the position (and diameter) of all of the neurons in a neuronlist using the
# convert from microns to nm Cell07PNs.nm = Cell07PNs*1e3 plot(Cell07PNs.nm)
There is also a more powerful
xform function that allows arbitrary transformations to be applied. For example here we apply a 3D rotation expressed as a homogeneous affine matrix:
# define a 180 degree rotation around the x axis rotm=cmtkparams2affmat(rx=180) # remove tiny values due to rounding errors rotm=zapsmall(rotm) plot(xform(Cell07PNs, rotm))
More generally any function that works on a neuron can be applied to a neuronlist by using the function
nlapply. This is an analogue to base R’s
lapply function. This will take care of returning a new neuronlist with the attached metadata and includes additional features such as error tolerance, progress bars and parallelisation for multi-core machines. It is worth reviewing the help and examples for this function carefully if you start to work regularly with neuronlists.
We have already seen that we can plot a single neuron (the first) like so:
The purple node highlights the root or soma of the neuron, red nodes are branch points, green nodes are end points. We can also label each node with its
plot(Cell07PNs[], col='red', WithText=T)
Multiple neurons can be plotted by passing a whole neuronlist or indexing it
More complex subsets are possible by using
plot.neuronlist subset argument (which works in the same way as the
subset.neuronlist function). For example here we select neurons by which olfactory glomeruli their dendrites occupy:
So far we have only used 2D plots in this document, but especially for interactive analysis and exploration, it is much more helpful to have 3D plots that can be rotated, zoomed etc. nat provides numerous functions for 3D plots based on the rgl package. It is actually possible to embed fully interactive 3d figures in rmarkdown reports like this one by setting the webgl chunk option.
You should be able to rotate (click and drag) and zoom (mouse wheel) this figure.
Since this results in quite large html files when used with many neurons, we will not use it further here. For now let’s show a plot in which we both select a subset of neurons and colour them according to their glomerulus of origin.