From f54e2029b4a225defbe3647c83d38489faf7adfc Mon Sep 17 00:00:00 2001 From: dokato Date: Tue, 19 Apr 2022 20:03:01 +0100 Subject: [PATCH] changed documentation of neuronlist - query can be neurons --- DESCRIPTION | 2 +- R/neuriteblast.r | 2 +- man/nat.nblast-package.Rd | 3 --- man/nblast.Rd | 2 +- 4 files changed, 3 insertions(+), 6 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index b024d15..a9a0021 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -33,6 +33,6 @@ Suggests: License: GPL-3 LazyData: yes VignetteBuilder: knitr -RoxygenNote: 7.0.2 +RoxygenNote: 7.1.2 Language: en-GB Encoding: UTF-8 diff --git a/R/neuriteblast.r b/R/neuriteblast.r index ab83657..ae051ea 100644 --- a/R/neuriteblast.r +++ b/R/neuriteblast.r @@ -32,7 +32,7 @@ #' across cores of the same machine. Before using this, the backend must be #' registered using \code{registerDoMC} (see example below). #' -#' @param query the query neuron. +#' @param query the query neuron, or neurons (\code{\link[nat]{neuronlist}}). #' @param target a \code{\link[nat]{neuronlist}} to compare neuron against. #' Defaults to \code{options("nat.default.neuronlist")}. See #' \code{\link{nat-package}}. diff --git a/man/nat.nblast-package.Rd b/man/nat.nblast-package.Rd index 5ce2767..e081791 100644 --- a/man/nat.nblast-package.Rd +++ b/man/nat.nblast-package.Rd @@ -5,9 +5,6 @@ \alias{nat.nblast-package} \alias{nat.nblast} \title{Neuron similarity, search and clustering tools} -\description{ -Neuron similarity, search and clustering tools -} \section{Similarity and search}{ diff --git a/man/nblast.Rd b/man/nblast.Rd index 7e9d4a8..a58722b 100644 --- a/man/nblast.Rd +++ b/man/nblast.Rd @@ -17,7 +17,7 @@ nblast( ) } \arguments{ -\item{query}{the query neuron.} +\item{query}{the query neuron, or neurons (\code{\link[nat]{neuronlist}}).} \item{target}{a \code{\link[nat]{neuronlist}} to compare neuron against. Defaults to \code{options("nat.default.neuronlist")}. See