R/modules.R

In LOGAN: Log File Analysis in International Large-Scale Assessments

#' Module 0: Data preparation
#' @name m0
#' @export
#' @details This module contains the following functions, which should be called
#'   by issuing "m0$<function_name>()": CleanActions, ConcatActions,
#'   DataActionsbyID, ImportSPSS, RangeNumberActionsbyVar, TrimVar
#' @importFrom modules module
m0 <- modules::module({
  export(
    "CleanActions", "ConcatActions", "DataActionsbyID", "ImportSPSS",
    "RangeNumberActionsbyVar", "TrimVar"
  )
  expose("R/CleanActions_m0.R")
  expose("R/ConcatActions_m0.R")
  expose("R/DataActionsbyID_m0.R")
  expose("R/ImportSPSS_m0.R")
  expose("R/RangeNumberActionsbyVar_m0.R")
  expose("R/TrimVar_m0.R")
})

#' Module 1: Time
#' @name m1
#' @export
#' @details This module contains the following functions, which should be called
#'   by issuing "m1$<function_name>()": NumericTimeVar, PlotTimeonTaskbyVar,
#'   SummaryTOTbyVar, TOTVar, VarTimebyID
m1 <- modules::module({
  # export("NumericTimeVar", "PlotTimeonTaskbyVar", "RangeTimeonTaskbyVar",
  #        "SummaryTOTbyVar", "TOTVar", "VarTimebyID")
  export(
    "NumericTimeVar", "PlotTimeonTaskbyVar", "SummaryTOTbyVar", "TOTVar",
    "VarTimebyID"
  )
  expose("R/NumericTimeVar_m1.R")
  expose("R/PlotTimeonTaskbyVar_m1.R")
  # expose("R/RangeTimeonTaskbyVar_m1.R")
  expose("R/SummaryTOTbyVar_m1.R")
  expose("R/TOTVar_m1.R")
  expose("R/VarTimebyID_m1.R")
})

#' Module 2: Actions (cognitive related)
#' @name m2
#' @export
#' @details This module contains the following functions, which should be called
#'   by issuing "m2$<function_name>()": DescriptiveStrategy,
#'   PlotStrategybyCatPerformance, VarActionSearch.
m2 <- modules::module({
  # export("BoxplotStrategybyPerformance", "DataArcSinebyPerformance",
  #        "DescriptiveStrategy", "FreqActionsSummary",
  #        "PlotStrategybyCatPerformance", "ScatterPlotbyPerformance",
  #        "VarActionPosition", "VarActionSearch")
  export(
    "DescriptiveStrategy", "PlotStrategybyCatPerformance",
    "VarActionSearch"
  )
  # expose("R/BoxplotStrategybyPerformance_m2.R")
  # expose("R/DataArcSinebyPerformance_m2.R")
  expose("R/DescriptiveStrategy_m2.R")
  # expose("R/FreqActionsSummary_m2.R")
  expose("R/PlotStrategybyCatPerformance_m2.R")
  # expose("R/ScatterPlotbyPerformance_m2.R")
  # expose("R/VarActionPosition_m2.R")
  expose("R/VarActionSearch_m2.R")
})