R/fslmer.R

In Deep-MI/fslmer: Univariate And Mass-Univariate Linear Mixed-Effects Analysis For FreeSurfer Imaging Data

#' fslmer: A package for univariate and mass-univariate linear mixed-effects analysis for FreeSurfer imaging data.
#'
#' The \strong{fslmer} package is a port of FreeSurfer's Matlab-based LME tools
#' to the R programming language.
#'
#' The package is provided via a GitHub repository at \url{https://github.com/Deep-MI/fslmer}.
#'
#' Please refer to the original documentation at \url{https://surfer.nmr.mgh.harvard.edu/fswiki/LongitudinalStatistics}
#' and \url{https://surfer.nmr.mgh.harvard.edu/fswiki/LinearMixedEffectsModels}
#' for an overview and further information about the software. For the original
#' code, see the original repository at \url{https://github.com/NeuroStats/lme}.
#'
#' If you use these tools in your analysis please cite:
#' \itemize{
#'   \item Bernal-Rusiel J.L., Greve D.N., Reuter M., Fischl B., Sabuncu M.R., 2012. Statistical Analysis of Longitudinal Neuroimage Data with Linear Mixed Effects Models, NeuroImage 66, 249-260, 2012, https://dx.doi.org/10.1016%2Fj.neuroimage.2012.10.065.
#'   \item Bernal-Rusiel J.L., Greve D.N., Reuter M., Fischl B., Sabuncu M.R., 2013. Spatiotemporal Linear Mixed Effects Modeling for the Mass-univariate Analysis of Longitudinal Neuroimage Data, NeuroImage 81, 358–370, 2013, https://doi.org/10.1016/j.neuroimage.2013.05.049.
#'   \item Reuter M., Schmansky N.J., Rosas H.D., Fischl B, 2012.Within-Subject Template Estimation for Unbiased Longitudinal Image Analysis, NeuroImage 61, 1402-1418, 2012, http://dx.doi.org/10.1016/j.neuroimage.2012.02.084.
#' }
#'
#' @section Examples:
#' Run \code{vignette("example-analyses", package = "fslmer")} to open the documentation for two analysis examples.
#'
#' @docType package
#' @name fslmer
NULL
#> NULL