R/Dyn4cast-package.R

In JobNmadu/Dyn4cast: Dynamic Modeling and Machine Learning Environment

#' @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
#' @aliases Dyn4cast-package
#' @details
#'
#' @section Website:
#' - The website for the package is at <https://jobnmadu.rbind.io/>
#'
#'#' @section Package options:
#' The following models and functions are covered in this package
#' + `DynamicForecast` which estimates the following models:
#' - `Spline without knots`
#' - `Spline with knots`
#' - `smooth.spline`
#' - `ARIMA`
#' - `Quadratic polynomial`
#' - `Ensembled with equal weight of the models ensembled`
#' - `Ensembled based on weight of each model ensembled`
#' - `Ensembled based on weight of fit of each model ensembled`
#' + `MLMetrics` which estimates over 40 machine learning selection metrics
#' + `MallowsCp`
#' + `Percent`
#' + `constrainedforecast`
#' + `invscaledlogit`
#' + `scaledlogit`
#' + `Linearsystems` which estimates the following models:
#' - `Linear model`
#' - `Linear model with interactions`
#' - `Semilog model`
#' - `Growth model`
#' - `Double Log model`
#' - `Mixed-power model`
#' - `Translog model`
#' - `Quadratic model`
#' - `Cubic model`
#' - `Inverse of y model`
#' - `Inverse of x model`
#' - `Inverse of y & x model`
#' - `Square root of model`
#' - `Cubic root of model`
#' - `formatted Model Table`
#' - `Prediction plots`
#' - `Fitted plots`
#' - `Naive effects plots`
#' - `Summary of numeric variables`
#' - `Summary of character variables`
#' + `Convert a continuous vector to a data frame`
#' + `Convert a raw data frame to a uniform data frame`
#' + `Plot of correlation matrix`
#' + `Plot of the order of significance of estimated coefficients`
#' + `quicksummary`
#' + `formattedcut`
#' + `data_transform`
#' + `Treatment model`
#' - `Estimated treatment effects model`
#' - `Data frame of the estimated various treatment effects`
#' - `Vector of estimated propensity scores from the model`
#' - `Vector of fitted values from the model`
#' - `Residuals of the estimated model`
#' - `Plot of the propensity scores from the model faceted into Treated and control populations`
#' - `Plot of the average treatment effect for the **entire** population`
#' - `Plot of the average treatment effect for the **treated** population`
#' - `Plot of the average treatment effect for the **controlled** population`
#' - `Plot of the average Treatment effect for the **evenly** population`