R/flywatch-package.R

#' Behaviour Analysis for Fly Tracking Data
#'
#' @section Yoshi Behaviour Rig:
#'
#'   For the time being this package focuses on analsyis of data derived from
#'   the four quadrant behaviour rig originally described in
#'   \href{http://dx.doi.org/10.7554/eLife.04580}{Aso et al. 2014}.
#'
#'   See the following functions: \itemize{
#'
#'   \item \code{\link{read_ybr_summary}}
#'
#'   \item \code{\link{read_ybr_xy}}
#'
#'   \item \code{\link{plot_ybr}}
#'
#'   \item \code{\link{plot_smoothed_displacement}}
#'
#'   }
#'
#'   for some interesting entry points to this code.
#'
#' @references \emph{Mushroom body output neurons encode valence and guide
#'   memory-based action selection in Drosophila.} Aso Y, Sitaraman D, Ichinose
#'   T, Kaun KR, Vogt K, Belliart-Guerin G, Placais PY, Robie AA, Yamagata N,
#'   Schnaitmann C, Rowell WJ, Johnston RM, Ngo TT, Chen N, Korff W, Nitabach
#'   MN, Heberlein U, Preat T, Branson KM, Tanimoto H, Rubin GM.. \bold{eLIFE}.
#'   2014 Dec 23;3:e04580. \href{http://dx.doi.org/10.7554/eLife.04580}{doi:
#'   10.7554/eLife.04580}.
#'
#' @keywords internal
"_PACKAGE"

# The following block is used by usethis to automatically manage
# roxygen namespace tags. Modify with care!
## usethis namespace: start
## usethis namespace: end
NULL
jefferislab/flywatch documentation built on Aug. 6, 2021, 12:14 p.m.