R/reg_repos.R

In natverse/nat.flybrains: Additional data for use with the NeuroAnatomy Toolbox (nat)

#' Download (or update) and install Jefferis lab registrations
#'
#' Uses \code{nat.templatebrains::\link{download_reg_repo}} to download git
#' repositories containing bridging and mirroring registrations for Drosophila
#' melanogaster, simulans and virilis template brains.
#'
#' @param repos character vector of Jefferis Lab GitHub repositories to download
#'   from.
#'
#' @seealso \url{https://github.com/jefferislab/BridgingRegistrations},
#'   \url{https://github.com/jefferislab/MirrorRegistrations}, and
#'   \url{https://github.com/jefferislab/DrosophilidBridgingRegistrations}.
#' @export
#' @seealso \code{\link{download_reg_repo}}
#' @references For a full description and sample applications of these registrations,
#'   please see:
#'
#' Combining genome-scale Drosophila 3D neuroanatomical data by bridging template brains
#' James D. Manton, Aaron D. Ostrovsky, Lea Goetz, Marta Costa, Torsten Rohlfing,
#' Gregory S. X. E. Jefferis
#' \href{http://dx.doi.org/10.1101/006353}{bioRxiv doi: 10.1101/006353}
#' @examples
#' \dontrun{
#' # to download just one of these repositories do e.g.:
#' download_jefferislab_registrations("Mirror")
#'
#' # to download your own registration repositories for use do
#' download_reg_repo("https://github.com/myuser/myrepo")
#' }
download_jefferislab_registrations <- function(repos=c("BridgingRegistrations", "MirrorRegistrations", "DrosophilidBridgingRegistrations")) {
  repos=match.arg(repos, several.ok = TRUE)
  download_reg_repo(paste0("jefferislab/", repos))
}