R/gimme-pkg.R

In gimme: Group Iterative Multiple Model Estimation

#' @name gimme-package
#' @aliases gimme-package
#' @title Group iterative multiple model estimation
#' @description This package contains functions to automatically identify the structure of group- and individual-level networks 
#' from a range of vector autoregressive models, estimated with structural equation modeling.
#' @author {
#'    Stephanie Lane [aut, trl],\cr 
#'    Kathleen Gates [aut, cre], \cr
#'    Zachary Fisher [aut],  \cr
#'    Cara Arizmendi [aut], \cr
#'    Peter Molenaar [aut], \cr
#'    Michael Hallquist [ctb], \cr
#'    Hallie Pike [ctb],  \cr
#'    Cara Arizmendi [ctb], \cr
#'    Teague Henry [ctb], \cr
#'    Kelly Duffy [ctb], \cr
#'    Lan Luo [ctb], \cr
#'    Adriene Beltz [csp]
#' }
#' Maintainer: KM Gates \email{gateskm@email.unc.edu}
#' @import lavaan 
#' @import MIIVsem 
#' @import igraph
#' @import data.tree
#' @importFrom grDevices dev.off pdf
#' @importFrom stats aggregate ave complete.cases qchisq qnorm reshape time cov sd na.omit lm convolve
#' @importFrom utils capture.output head read.table write.csv write.table file_test read.csv getFromNamespace
#' @importFrom qgraph qgraph 
#' @importFrom imputeTS na.kalman
#' @importFrom stats ts
#' @importFrom igraph graph_from_adjacency_matrix cluster_walktrap modularity membership
#' @importFrom graphics plot
#' @keywords gimme
#' @details Researchers across varied domains gather multivariate data for each individual unit of study
#' across multiple occasions of measurement. Generally referred to as time series
#' (or in the social sciences, intensive longitudinal) data, examples include
#' psychophysiological processes such as neuroimaging and heart rate variability,
#' daily diary studies, ecological momentary assessments, data passively collected from devices such as smartphones, 
#' and observational coding of social interactions among dyads.
#' 
#' A primary goal for acquiring these data is to understand dynamic processes.
#' The gimme package contains several functions for use with these data.
#' These functions include \code{\link{gimmeSEM}}, which provides both group-
#'  and individual-level results by looking across individuals for patterns of
#'   relations among variables. A function that provides group-level results,
#'   \code{\link{aggSEM}}, is included, as well as a function that provides
#'    individual-level results, \code{\link{indSEM}}. The major functions within the gimme package all require the
#'    user to specify the data, although many additional options exist.
NULL