Update workflowRender.R

Author: xieguigang

R/workflowRender.R

@@ -32,8 +32,47 @@ const run = function(registry = NULL, disables = list()) {
     __runImpl(context = .get_context(), disables);
 }
 
-#' An internal function for start the workflow
+#' Internal Workflow Execution Engine
+#' 
+#' @description 
+#' An internal function that drives the execution of a modular workflow. 
+#' It sequentially processes analysis modules according to the pipeline 
+#' configuration while respecting disablement rules.
+#'
+#' @param context A workflow context object containing:
+#' \itemize{
+#'   \item{pipeline - character vector of module execution order}
+#'   \item{workflow - list of module definitions}
+#' }
+#' @param disables A named list specifying module disablement status. 
+#' Format: `list(module_name = TRUE/FALSE)`. Modules with TRUE will be skipped.
+#' 
+#' @details
+#' This function:
+#' \enumerate{
+#'   \item Retrieves module execution order from `context$pipeline`
+#'   \item Checks disablement status through two mechanisms:
+#'     \itemize{
+#'       \item Explicit disablement via `disables` parameter
+#'       \item Module's own `disable` property (set by upstream modules)
+#'     }
+#'   \item Executes non-disabled modules using `.internal_call()`
+#'   \item Provides verbose logging when `options(verbose=TRUE)`
+#' }
+#' 
+#' The workflow context is modified in-place by module execution.
+#'
+#' @note
+#' This is an internal function not meant for direct calling by users. 
+#' Modules can control subsequent module execution by setting their 
+#' `disable` property.
+#' 
+#' @return
+#' Invisibly returns NULL. Modifies the workflow context object in-place
+#' through module executions.
 #'
+#' @keywords internal
+#' @seealso \code{\link{.internal_call}} for module execution logic
 const __runImpl = function(context, disables = list()) {
     let app_pool = context$workflow;
     let skip = FALSE;