diff --git a/DESCRIPTION b/DESCRIPTION index 3e9be63..e3ec043 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Package: nat.nblast Type: Package Title: NeuroAnatomy Toolbox ('nat') Extension for Assessing Neuron Similarity and Clustering -Version: 1.6.6 +Version: 1.6.7 Authors@R: c( person("Gregory", "Jefferis", email= "jefferis@gmail.com", role = c("aut"), comment = c(ORCID = "0000-0002-0587-9355")), @@ -11,7 +11,7 @@ Authors@R: c( ) Description: Extends package 'nat' (NeuroAnatomy Toolbox) by providing a collection of NBLAST-related functions for neuronal morphology comparison (Costa et al. (2016) ). -URL: https://github.com/natverse/nat.nblast, https://natverse.github.io +URL: https://natverse.org/nat.nblast/ BugReports: https://github.com/natverse/nat.nblast/issues Depends: R (>= 2.15.1), @@ -33,6 +33,6 @@ Suggests: License: GPL-3 LazyData: yes VignetteBuilder: knitr -RoxygenNote: 7.1.1 +RoxygenNote: 7.2.3 Language: en-GB Encoding: UTF-8 diff --git a/NAMESPACE b/NAMESPACE index 6bcbcaf..08bbf8e 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,6 +1,7 @@ # Generated by roxygen2: do not edit by hand S3method("dimnames<-",spam) +S3method(WeightedNNBasedLinesetMatching,default) S3method(WeightedNNBasedLinesetMatching,dotprops) S3method(WeightedNNBasedLinesetMatching,neuron) S3method(diagonal,default) diff --git a/R/DATA.r b/R/DATA.r index aec1de0..be7330c 100644 --- a/R/DATA.r +++ b/R/DATA.r @@ -5,8 +5,8 @@ #' same type, rather than unrelated neurons. #' #' These scoring matrices were generated using all by all pairs from 150 DL2 -#' antennal lobe projection neurons from the \url{http://flycircuit.tw} dataset -#' and 5000 random pairs from the same dataset. +#' antennal lobe projection neurons from the FlyCircuit dataset and 5000 random +#' pairs from the same dataset. #' #' \itemize{ #' @@ -34,10 +34,10 @@ NULL #' #' This R list (which has additional class \code{neuronlist}) contains 15 #' skeletonized \emph{Drosophila} neurons as \code{dotprops} objects. Original -#' data is due to Chiang et al. [1], who have generously shared their raw data -#' at \url{http://flycircuit.tw}. Automated tracing of neuron skeletons was -#' carried out by Lee et al [2]. Image registration and further processing was -#' carried out by Greg Jefferis, Marta Costa and James Manton[3]. +#' data is due to Chiang et al. [1], who have generously shared their raw data. +#' Automated tracing of neuron skeletons was carried out by Lee et al [2]. Image +#' registration and further processing was carried out by Greg Jefferis, Marta +#' Costa and James Manton[3]. #' @name fctraces20 #' @docType data #' @references [1] Chiang A.S., Lin C.Y., Chuang C.C., Chang H.M., Hsieh C.H., @@ -45,16 +45,16 @@ NULL #' Ching Y.T., Lee P.C., Lin C.Y., Lin H.H., Wu C.C., Hsu H.W., Huang Y.A., #' Chen J.Y., et al. (2011). Three-dimensional reconstruction of brain-wide #' wiring networks in Drosophila at single-cell resolution. Curr Biol 21 (1), -#' 1--11. doi: \url{http://doi.org/10.1016/j.cub.2010.11.056} +#' 1--11. doi: \doi{10.1016/j.cub.2010.11.056} #' #' [2] P.-C. Lee, C.-C. Chuang, A.-S. Chiang, and Y.-T. Ching. (2012). #' High-throughput computer method for 3d neuronal structure reconstruction #' from the image stack of the Drosophila brain and its applications. PLoS #' Comput Biol, 8(9):e1002658, Sep 2012. doi: -#' \url{http://doi.org/10.1371/journal.pcbi.1002658}. +#' \doi{10.1371/journal.pcbi.1002658}. #' #' [3] NBLAST: Rapid, sensitive comparison of neuronal structure and #' construction of neuron family databases. Marta Costa, Aaron D. Ostrovsky, #' James D. Manton, Steffen Prohaska, Gregory S.X.E. Jefferis. bioRxiv doi: -#' \url{http://doi.org/10.1101/006346}. +#' \doi{10.1101/006346}. NULL diff --git a/R/nat.nblast.r b/R/nat.nblast.r index 4bb2afb..b39813a 100644 --- a/R/nat.nblast.r +++ b/R/nat.nblast.r @@ -1,5 +1,8 @@ #' Neuron similarity, search and clustering tools #' +#' \bold{nat.nblast} provides tools to compare neuronal morphology using the +#' NBLAST algorithm (Costa et al. 2016). +#' #' @section Similarity and search: #' #' The main entry point for similarity and search functions is @@ -82,7 +85,7 @@ #' @references Costa, M., Ostrovsky, A.D., Manton, J.D., Prohaska, S., and #' Jefferis, G.S.X.E. (2014). NBLAST: Rapid, sensitive comparison of neuronal #' structure and construction of neuron family databases. bioRxiv preprint. -#' \href{http://dx.doi.org/10.1101/006346}{doi: 10.1101/006346}. +#' \doi{10.1101/006346}. #' #' @name nat.nblast-package #' @aliases nat.nblast diff --git a/R/neuriteblast.r b/R/neuriteblast.r index 775b4c2..36af343 100644 --- a/R/neuriteblast.r +++ b/R/neuriteblast.r @@ -105,19 +105,18 @@ #' @references Kohl, J. Ostrovsky, A.D., Frechter, S., and Jefferis, G.S.X.E #' (2013). A bidirectional circuit switch reroutes pheromone signals in male #' and female brains. Cell 155 (7), 1610--23 -#' \href{http://dx.doi.org/10.1016/j.cell.2013.11.025}{doi: -#' 10.1016/j.cell.2013.11.025}. +#' \doi{10.1016/j.cell.2013.11.025}. #' #' Costa, M., Ostrovsky, A.D., Manton, J.D., Prohaska, S., and Jefferis, #' G.S.X.E. (2014). NBLAST: Rapid, sensitive comparison of neuronal structure #' and construction of neuron family databases. bioRxiv preprint. -#' \href{http://dx.doi.org/10.1101/006346}{doi: 10.1101/006346}. +#' \doi{10.1101/006346}. #' #' Jefferis G.S.X.E., Potter C.J., Chan A.M., Marin E.C., Rohlfing T., Maurer #' C.R.J., and Luo L. (2007). Comprehensive maps of Drosophila higher #' olfactory centers: spatially segregated fruit and pheromone representation. #' Cell 128 (6), 1187--1203. -#' \href{http://dx.doi.org/10.1016/j.cell.2007.01.040}{doi:10.1016/j.cell.2007.01.040} +#' \doi{10.1016/j.cell.2007.01.040} #' #' #' @@ -410,7 +409,7 @@ WeightedNNBasedLinesetMatching.neuron<-function(target, query, UseAlpha=FALSE, WeightedNNBasedLinesetMatching(target, query, ...) } - +#' @export WeightedNNBasedLinesetMatching.default<-function(target,query,dvs1=NULL,dvs2=NULL,alphas1=NULL, alphas2=NULL,NNDistFun=WeightedNNBasedLinesetDistFun,Verbose=FALSE, BothDirections=FALSE,BothDirectionsFun=list,OnlyClosestPoints=FALSE,...){ diff --git a/README.md b/README.md index 642f851..c57b3ca 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # nat.nblast -[![natverse](https://img.shields.io/badge/natverse-Part%20of%20the%20natverse-a241b6)](https://natverse.github.io) +[![natverse](https://img.shields.io/badge/natverse-Part%20of%20the%20natverse-a241b6)](https://natverse.org/) [![Release Version](https://img.shields.io/github/release/natverse/nat.nblast.svg)](https://github.com/natverse/nat.nblast/releases/latest) [![CRAN status](https://www.r-pkg.org/badges/version/nat.nblast)](https://CRAN.R-project.org/package=nat.nblast) -[![Build Status](https://travis-ci.org/natverse/nat.nblast.svg?branch=master)](https://travis-ci.org/natverse/nat.nblast) -[![Docs](https://img.shields.io/badge/docs-100%25-brightgreen.svg)](https://natverse.github.io/nat.nblast/reference/) +[![Build Status](https://travis-ci.org/natverse/nat.nblast.svg?branch=master)](https://app.travis-ci.com/natverse/nat.nblast) +[![Docs](https://img.shields.io/badge/docs-100%25-brightgreen.svg)](https://natverse.org/nat.nblast/reference/) **nat.nblast** is part of the [NeuroAnatomy Toolbox](https://jefferislab.github.io/) @@ -52,13 +52,13 @@ databases of neurons. There is also support for all x all comparison for a group of neurons. This can produce a distance matrix suitable for hierarchical clustering, which is also implemented in the package. -These tools are designed as an addon for the [NeuroAnatomy Toolbox](https://natverse.github.io/nat) +These tools are designed as an addon for the [NeuroAnatomy Toolbox](https://natverse.org/nat/) (nat) R package, which will be installed as dependency. You will probably find the following online documentation helpful: -* https://natverse.github.io/nat.nblast - Online documentation for this R package -* http://jefferislab.org/si/nblast - Overview of NBLAST algorithm and online tools +* https://natverse.org/nat.nblast/ - Online documentation for this R package +* https://jefferislab.org/si/nblast/ - Overview of NBLAST algorithm and online tools ## Installation This package has been released to [CRAN](https://cran.r-project.org/package=nat.nblast) @@ -81,6 +81,6 @@ devtools::install_github("natverse/nat.nblast") ``` Note that this will also update the [nat package](https://github.com/natverse/nat) to the latest development version from github. Windows users need -[Rtools](http://www.murdoch-sutherland.com/Rtools/) to install this way. +[Rtools](https://www.murdoch-sutherland.com/Rtools/) to install this way. diff --git a/man/fctraces20.Rd b/man/fctraces20.Rd index 286bd21..336cdff 100644 --- a/man/fctraces20.Rd +++ b/man/fctraces20.Rd @@ -7,10 +7,10 @@ \description{ This R list (which has additional class \code{neuronlist}) contains 15 skeletonized \emph{Drosophila} neurons as \code{dotprops} objects. Original -data is due to Chiang et al. [1], who have generously shared their raw data -at \url{http://flycircuit.tw}. Automated tracing of neuron skeletons was -carried out by Lee et al [2]. Image registration and further processing was -carried out by Greg Jefferis, Marta Costa and James Manton[3]. +data is due to Chiang et al. [1], who have generously shared their raw data. +Automated tracing of neuron skeletons was carried out by Lee et al [2]. Image +registration and further processing was carried out by Greg Jefferis, Marta +Costa and James Manton[3]. } \references{ [1] Chiang A.S., Lin C.Y., Chuang C.C., Chang H.M., Hsieh C.H., @@ -18,16 +18,16 @@ carried out by Greg Jefferis, Marta Costa and James Manton[3]. Ching Y.T., Lee P.C., Lin C.Y., Lin H.H., Wu C.C., Hsu H.W., Huang Y.A., Chen J.Y., et al. (2011). Three-dimensional reconstruction of brain-wide wiring networks in Drosophila at single-cell resolution. Curr Biol 21 (1), - 1--11. doi: \url{http://doi.org/10.1016/j.cub.2010.11.056} + 1--11. doi: \doi{10.1016/j.cub.2010.11.056} [2] P.-C. Lee, C.-C. Chuang, A.-S. Chiang, and Y.-T. Ching. (2012). High-throughput computer method for 3d neuronal structure reconstruction from the image stack of the Drosophila brain and its applications. PLoS Comput Biol, 8(9):e1002658, Sep 2012. doi: - \url{http://doi.org/10.1371/journal.pcbi.1002658}. + \doi{10.1371/journal.pcbi.1002658}. [3] NBLAST: Rapid, sensitive comparison of neuronal structure and construction of neuron family databases. Marta Costa, Aaron D. Ostrovsky, James D. Manton, Steffen Prohaska, Gregory S.X.E. Jefferis. bioRxiv doi: - \url{http://doi.org/10.1101/006346}. + \doi{10.1101/006346}. } diff --git a/man/nat.nblast-package.Rd b/man/nat.nblast-package.Rd index e081791..0de827a 100644 --- a/man/nat.nblast-package.Rd +++ b/man/nat.nblast-package.Rd @@ -5,6 +5,10 @@ \alias{nat.nblast-package} \alias{nat.nblast} \title{Neuron similarity, search and clustering tools} +\description{ +\bold{nat.nblast} provides tools to compare neuronal morphology using the +NBLAST algorithm (Costa et al. 2016). +} \section{Similarity and search}{ @@ -98,7 +102,7 @@ Costa, M., Ostrovsky, A.D., Manton, J.D., Prohaska, S., and Jefferis, G.S.X.E. (2014). NBLAST: Rapid, sensitive comparison of neuronal structure and construction of neuron family databases. bioRxiv preprint. - \href{http://dx.doi.org/10.1101/006346}{doi: 10.1101/006346}. + \doi{10.1101/006346}. } \seealso{ \code{\link{nblast}}, \code{\link{smat.fcwb}}, diff --git a/man/nblast.Rd b/man/nblast.Rd index 74a7aba..a0dc1f1 100644 --- a/man/nblast.Rd +++ b/man/nblast.Rd @@ -173,19 +173,18 @@ stopifnot(all.equal(scores.norm2, scores.norm)) Kohl, J. Ostrovsky, A.D., Frechter, S., and Jefferis, G.S.X.E (2013). A bidirectional circuit switch reroutes pheromone signals in male and female brains. Cell 155 (7), 1610--23 - \href{http://dx.doi.org/10.1016/j.cell.2013.11.025}{doi: - 10.1016/j.cell.2013.11.025}. + \doi{10.1016/j.cell.2013.11.025}. Costa, M., Ostrovsky, A.D., Manton, J.D., Prohaska, S., and Jefferis, G.S.X.E. (2014). NBLAST: Rapid, sensitive comparison of neuronal structure and construction of neuron family databases. bioRxiv preprint. - \href{http://dx.doi.org/10.1101/006346}{doi: 10.1101/006346}. + \doi{10.1101/006346}. Jefferis G.S.X.E., Potter C.J., Chan A.M., Marin E.C., Rohlfing T., Maurer C.R.J., and Luo L. (2007). Comprehensive maps of Drosophila higher olfactory centers: spatially segregated fruit and pheromone representation. Cell 128 (6), 1187--1203. - \href{http://dx.doi.org/10.1016/j.cell.2007.01.040}{doi:10.1016/j.cell.2007.01.040} + \doi{10.1016/j.cell.2007.01.040} } \seealso{ \code{\link{nat-package}}, \code{\link{nblast_allbyall}}, diff --git a/man/smat.fcwb.Rd b/man/smat.fcwb.Rd index ac57b4c..fa5cf04 100644 --- a/man/smat.fcwb.Rd +++ b/man/smat.fcwb.Rd @@ -12,8 +12,8 @@ same type, rather than unrelated neurons. } \details{ These scoring matrices were generated using all by all pairs from 150 DL2 -antennal lobe projection neurons from the \url{http://flycircuit.tw} dataset -and 5000 random pairs from the same dataset. +antennal lobe projection neurons from the FlyCircuit dataset and 5000 random +pairs from the same dataset. \itemize{