From e68839a5c8fa36b361dcc4abfa4103c5d3c5a9d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=81=93=E3=81=AE=E4=B8=AD=E4=BA=8C=E7=97=85=E3=81=AB?= =?UTF-8?q?=E7=88=86=E7=84=94=E3=82=92=EF=BC=81?= Date: Mon, 5 Aug 2024 10:47:51 +0800 Subject: [PATCH] run package document msbuild --- man/.get_context.1 | 2 +- man/.internal_call.1 | 2 +- man/.onLoad.1 | 2 +- man/__build_app.1 | 2 +- man/__runImpl.1 | 2 +- man/__workfile_uri_parser.1 | 2 +- man/__workfiles.1 | 2 +- man/app.1 | 2 +- man/app_check.delegate.1 | 2 +- man/app_check.signature.1 | 2 +- man/check_dependency.1 | 2 +- man/check_dependency.context_env.1 | 2 +- man/check_dependency.localfiles.1 | 2 +- man/create_memory_context.1 | 2 +- man/definePipeline.1 | 2 +- man/dependency.context_env_missing.1 | 2 +- man/dependency.workfiles_missing.1 | 2 +- man/dependency_analysis.1 | 2 +- man/dependency_graph.1 | 2 +- man/echo_warning.1 | 2 +- man/extract_workflow_vertex.1 | 2 +- man/filepath_safe.1 | 2 +- man/finalize.1 | 2 +- man/get_appName.func_reference.1 | 2 +- man/get_appName.obj.1 | 2 +- man/get_app_name.1 | 2 +- man/get_config.1 | 2 +- man/get_functionName.1 | 2 +- man/get_timestamp.1 | 2 +- man/has_cachefile.1 | 2 +- man/hook.1 | 2 +- man/init_context.1 | 2 +- man/pull_configs.1 | 2 +- man/run.1 | 2 +- man/set_config.1 | 2 +- man/set_dependency.1 | 2 +- man/set_disable.1 | 2 +- man/summary.1 | 2 +- man/tabulate_workflow_summary.1 | 2 +- man/throw_err.1 | 2 +- man/use_cache.1 | 2 +- man/workdir_root.1 | 2 +- man/workfile.1 | 2 +- man/workspace.1 | 2 +- vignettes/R/docs/.get_context.html | 4 ++-- vignettes/R/docs/.internal_call.html | 4 ++-- vignettes/R/docs/.onLoad.html | 4 ++-- vignettes/R/docs/__build_app.html | 4 ++-- vignettes/R/docs/__runImpl.html | 4 ++-- vignettes/R/docs/__workfile_uri_parser.html | 4 ++-- vignettes/R/docs/__workfiles.html | 4 ++-- vignettes/R/docs/app.html | 4 ++-- vignettes/R/docs/app_check.delegate.html | 4 ++-- vignettes/R/docs/app_check.signature.html | 4 ++-- vignettes/R/docs/check_dependency.context_env.html | 4 ++-- vignettes/R/docs/check_dependency.html | 4 ++-- vignettes/R/docs/check_dependency.localfiles.html | 4 ++-- vignettes/R/docs/create_memory_context.html | 4 ++-- vignettes/R/docs/definePipeline.html | 4 ++-- vignettes/R/docs/dependency.context_env_missing.html | 4 ++-- vignettes/R/docs/dependency.workfiles_missing.html | 4 ++-- vignettes/R/docs/dependency_analysis.html | 4 ++-- vignettes/R/docs/dependency_graph.html | 4 ++-- vignettes/R/docs/echo_warning.html | 4 ++-- vignettes/R/docs/extract_workflow_vertex.html | 4 ++-- vignettes/R/docs/filepath_safe.html | 4 ++-- vignettes/R/docs/finalize.html | 4 ++-- vignettes/R/docs/get_appName.func_reference.html | 4 ++-- vignettes/R/docs/get_appName.obj.html | 4 ++-- vignettes/R/docs/get_app_name.html | 4 ++-- vignettes/R/docs/get_config.html | 4 ++-- vignettes/R/docs/get_functionName.html | 4 ++-- vignettes/R/docs/get_timestamp.html | 4 ++-- vignettes/R/docs/has_cachefile.html | 4 ++-- vignettes/R/docs/hook.html | 4 ++-- vignettes/R/docs/init_context.html | 4 ++-- vignettes/R/docs/pull_configs.html | 4 ++-- vignettes/R/docs/run.html | 4 ++-- vignettes/R/docs/set_config.html | 4 ++-- vignettes/R/docs/set_dependency.html | 4 ++-- vignettes/R/docs/set_disable.html | 4 ++-- vignettes/R/docs/summary.html | 4 ++-- vignettes/R/docs/tabulate_workflow_summary.html | 4 ++-- vignettes/R/docs/throw_err.html | 4 ++-- vignettes/R/docs/use_cache.html | 4 ++-- vignettes/R/docs/workdir_root.html | 4 ++-- vignettes/R/docs/workfile.html | 4 ++-- vignettes/R/docs/workspace.html | 4 ++-- vignettes/index.html | 8 +++++++- vignettes/keywords.html | 3 ++- 90 files changed, 141 insertions(+), 134 deletions(-) diff --git a/man/.get_context.1 b/man/.get_context.1 index 504dca5..6741f07 100644 --- a/man/.get_context.1 +++ b/man/.get_context.1 @@ -1,4 +1,4 @@ -.TH .GET_CONTEXT 1 2024-Jul "" "get current workflow environment context" +.TH .GET_CONTEXT 1 2024-Aug "" "get current workflow environment context" .SH NAME .get_context \- .get_context() .SH SYNOPSIS diff --git a/man/.internal_call.1 b/man/.internal_call.1 index 0e6d7e6..3ae4284 100644 --- a/man/.internal_call.1 +++ b/man/.internal_call.1 @@ -1,4 +1,4 @@ -.TH .INTERNAL_CALL 1 2024-Jul "" "Invoke an analysis application" +.TH .INTERNAL_CALL 1 2024-Aug "" "Invoke an analysis application" .SH NAME .internal_call \- .internal_call(app, context) .SH SYNOPSIS diff --git a/man/.onLoad.1 b/man/.onLoad.1 index 5c1401b..0faf066 100644 --- a/man/.onLoad.1 +++ b/man/.onLoad.1 @@ -1,4 +1,4 @@ -.TH .ONLOAD 1 2024-Jul "" ".onLoad" +.TH .ONLOAD 1 2024-Aug "" ".onLoad" .SH NAME .onLoad \- .onLoad() .SH SYNOPSIS diff --git a/man/__build_app.1 b/man/__build_app.1 index 1bb65ad..fdf52b0 100644 --- a/man/__build_app.1 +++ b/man/__build_app.1 @@ -1,4 +1,4 @@ -.TH __BUILD_APP 1 2024-Jul "" "Build workflow app object" +.TH __BUILD_APP 1 2024-Aug "" "Build workflow app object" .SH NAME __build_app \- __build_app(f) .SH SYNOPSIS diff --git a/man/__runImpl.1 b/man/__runImpl.1 index 68b2999..d621aac 100644 --- a/man/__runImpl.1 +++ b/man/__runImpl.1 @@ -1,4 +1,4 @@ -.TH __RUNIMPL 1 2024-Jul "" "An internal function for start the workflow" +.TH __RUNIMPL 1 2024-Aug "" "An internal function for start the workflow" .SH NAME __runImpl \- __runImpl(context, disables = 'list'()) diff --git a/man/__workfile_uri_parser.1 b/man/__workfile_uri_parser.1 index 42b6761..42b11fc 100644 --- a/man/__workfile_uri_parser.1 +++ b/man/__workfile_uri_parser.1 @@ -1,4 +1,4 @@ -.TH __WORKFILE_URI_PARSER 1 2024-Jul "" "parse the workfile expression" +.TH __WORKFILE_URI_PARSER 1 2024-Aug "" "parse the workfile expression" .SH NAME __workfile_uri_parser \- __workfile_uri_parser(uri) .SH SYNOPSIS diff --git a/man/__workfiles.1 b/man/__workfiles.1 index 878ac97..7b47c22 100644 --- a/man/__workfiles.1 +++ b/man/__workfiles.1 @@ -1,4 +1,4 @@ -.TH __WORKFILES 1 2024-Jul "" "parse the workfile expression" +.TH __WORKFILES 1 2024-Aug "" "parse the workfile expression" .SH NAME __workfiles \- __workfiles(files.uri) .SH SYNOPSIS diff --git a/man/app.1 b/man/app.1 index de20e9a..957efb4 100644 --- a/man/app.1 +++ b/man/app.1 @@ -1,4 +1,4 @@ -.TH APP 1 2024-Jul "" "Analysis app constructor" +.TH APP 1 2024-Aug "" "Analysis app constructor" .SH NAME app \- app(name, analysis, desc = 'no description', diff --git a/man/app_check.delegate.1 b/man/app_check.delegate.1 index 33b937e..5ff0399 100644 --- a/man/app_check.delegate.1 +++ b/man/app_check.delegate.1 @@ -1,4 +1,4 @@ -.TH APP_CHECK.DELEGATE 1 2024-Jul "" "Check the function signature of the app function" +.TH APP_CHECK.DELEGATE 1 2024-Aug "" "Check the function signature of the app function" .SH NAME app_check.delegate \- app_check.delegate(analysis) .SH SYNOPSIS diff --git a/man/app_check.signature.1 b/man/app_check.signature.1 index 5fa1e8d..74402f8 100644 --- a/man/app_check.signature.1 +++ b/man/app_check.signature.1 @@ -1,4 +1,4 @@ -.TH APP_CHECK.SIGNATURE 1 2024-Jul "" "check of the required app slot" +.TH APP_CHECK.SIGNATURE 1 2024-Aug "" "check of the required app slot" .SH NAME app_check.signature \- app_check.signature(app) .SH SYNOPSIS diff --git a/man/check_dependency.1 b/man/check_dependency.1 index 8b0e6a8..78a8df3 100644 --- a/man/check_dependency.1 +++ b/man/check_dependency.1 @@ -1,4 +1,4 @@ -.TH CHECK_DEPENDENCY 1 2024-Jul "" "Check of the analysis app dependency" +.TH CHECK_DEPENDENCY 1 2024-Aug "" "Check of the analysis app dependency" .SH NAME check_dependency \- check_dependency(app, context = '.get_context'()) diff --git a/man/check_dependency.context_env.1 b/man/check_dependency.context_env.1 index 7bd5057..15dbaea 100644 --- a/man/check_dependency.context_env.1 +++ b/man/check_dependency.context_env.1 @@ -1,4 +1,4 @@ -.TH CHECK_DEPENDENCY.CONTEXT_ENV 1 2024-Jul "" "Check of the required environment symbols" +.TH CHECK_DEPENDENCY.CONTEXT_ENV 1 2024-Aug "" "Check of the required environment symbols" .SH NAME check_dependency.context_env \- check_dependency.context_env(requires, context) .SH SYNOPSIS diff --git a/man/check_dependency.localfiles.1 b/man/check_dependency.localfiles.1 index 3ec4433..d0cdd28 100644 --- a/man/check_dependency.localfiles.1 +++ b/man/check_dependency.localfiles.1 @@ -1,4 +1,4 @@ -.TH CHECK_DEPENDENCY.LOCALFILES 1 2024-Jul "" "Check for the upstream file dependency" +.TH CHECK_DEPENDENCY.LOCALFILES 1 2024-Aug "" "Check for the upstream file dependency" .SH NAME check_dependency.localfiles \- check_dependency.localfiles(requires, context) .SH SYNOPSIS diff --git a/man/create_memory_context.1 b/man/create_memory_context.1 index 486cfe2..6407677 100644 --- a/man/create_memory_context.1 +++ b/man/create_memory_context.1 @@ -1,4 +1,4 @@ -.TH CREATE_MEMORY_CONTEXT 1 2024-Jul "" "create an in-memory context object just used for run debug" +.TH CREATE_MEMORY_CONTEXT 1 2024-Aug "" "create an in-memory context object just used for run debug" .SH NAME create_memory_context \- create_memory_context( mounts = NULL) diff --git a/man/definePipeline.1 b/man/definePipeline.1 index ae0a8aa..47c6561 100644 --- a/man/definePipeline.1 +++ b/man/definePipeline.1 @@ -1,4 +1,4 @@ -.TH DEFINEPIPELINE 1 2024-Jul "" "Create a custom pipeline workflow execute sequence" +.TH DEFINEPIPELINE 1 2024-Aug "" "Create a custom pipeline workflow execute sequence" .SH NAME definePipeline \- definePipeline(seq) .SH SYNOPSIS diff --git a/man/dependency.context_env_missing.1 b/man/dependency.context_env_missing.1 index 7c0efb4..c4fa9ee 100644 --- a/man/dependency.context_env_missing.1 +++ b/man/dependency.context_env_missing.1 @@ -1,4 +1,4 @@ -.TH DEPENDENCY.CONTEXT_ENV_MISSING 1 2024-Jul "" "Generate the error message for missing context symbols" +.TH DEPENDENCY.CONTEXT_ENV_MISSING 1 2024-Aug "" "Generate the error message for missing context symbols" .SH NAME dependency.context_env_missing \- dependency.context_env_missing(context) .SH SYNOPSIS diff --git a/man/dependency.workfiles_missing.1 b/man/dependency.workfiles_missing.1 index 3967077..5f2703f 100644 --- a/man/dependency.workfiles_missing.1 +++ b/man/dependency.workfiles_missing.1 @@ -1,4 +1,4 @@ -.TH DEPENDENCY.WORKFILES_MISSING 1 2024-Jul "" "Generate the error message for the missing required work files" +.TH DEPENDENCY.WORKFILES_MISSING 1 2024-Aug "" "Generate the error message for the missing required work files" .SH NAME dependency.workfiles_missing \- dependency.workfiles_missing(file) .SH SYNOPSIS diff --git a/man/dependency_analysis.1 b/man/dependency_analysis.1 index 634c42e..399e6cd 100644 --- a/man/dependency_analysis.1 +++ b/man/dependency_analysis.1 @@ -1,4 +1,4 @@ -.TH DEPENDENCY_ANALYSIS 1 2024-Jul "" "dependency_analysis" +.TH DEPENDENCY_ANALYSIS 1 2024-Aug "" "dependency_analysis" .SH NAME dependency_analysis \- dependency_analysis(app) .SH SYNOPSIS diff --git a/man/dependency_graph.1 b/man/dependency_graph.1 index 97ef2e6..9b833f7 100644 --- a/man/dependency_graph.1 +++ b/man/dependency_graph.1 @@ -1,4 +1,4 @@ -.TH DEPENDENCY_GRAPH 1 2024-Jul "" "try to extract the dependency graph from the application modules" +.TH DEPENDENCY_GRAPH 1 2024-Aug "" "try to extract the dependency graph from the application modules" .SH NAME dependency_graph \- dependency_graph(mounts) .SH SYNOPSIS diff --git a/man/echo_warning.1 b/man/echo_warning.1 index 7a895bf..3266c14 100644 --- a/man/echo_warning.1 +++ b/man/echo_warning.1 @@ -1,4 +1,4 @@ -.TH ECHO_WARNING 1 2024-Jul "" "print warning message on the screen and the log file" +.TH ECHO_WARNING 1 2024-Aug "" "print warning message on the screen and the log file" .SH NAME echo_warning \- echo_warning(msg, app = NULL) diff --git a/man/extract_workflow_vertex.1 b/man/extract_workflow_vertex.1 index 7d461b4..a9b0d94 100644 --- a/man/extract_workflow_vertex.1 +++ b/man/extract_workflow_vertex.1 @@ -1,4 +1,4 @@ -.TH EXTRACT_WORKFLOW_VERTEX 1 2024-Jul "" "extract_workflow_vertex" +.TH EXTRACT_WORKFLOW_VERTEX 1 2024-Aug "" "extract_workflow_vertex" .SH NAME extract_workflow_vertex \- extract_workflow_vertex(meta) .SH SYNOPSIS diff --git a/man/filepath_safe.1 b/man/filepath_safe.1 index 926a990..6ea6eaa 100644 --- a/man/filepath_safe.1 +++ b/man/filepath_safe.1 @@ -1,4 +1,4 @@ -.TH FILEPATH_SAFE 1 2024-Jul "" "Create the file path safely" +.TH FILEPATH_SAFE 1 2024-Aug "" "Create the file path safely" .SH NAME filepath_safe \- filepath_safe(dir, filename, maxchars = 48) diff --git a/man/finalize.1 b/man/finalize.1 index 5489f05..3e3b13a 100644 --- a/man/finalize.1 +++ b/man/finalize.1 @@ -1,4 +1,4 @@ -.TH FINALIZE 1 2024-Jul "" "Mark end of the analysis workflow" +.TH FINALIZE 1 2024-Aug "" "Mark end of the analysis workflow" .SH NAME finalize \- finalize() .SH SYNOPSIS diff --git a/man/get_appName.func_reference.1 b/man/get_appName.func_reference.1 index e96c299..4f77a58 100644 --- a/man/get_appName.func_reference.1 +++ b/man/get_appName.func_reference.1 @@ -1,4 +1,4 @@ -.TH GET_APPNAME.FUNC_REFERENCE 1 2024-Jul "" "get app name from the analysis function as reference" +.TH GET_APPNAME.FUNC_REFERENCE 1 2024-Aug "" "get app name from the analysis function as reference" .SH NAME get_appName.func_reference \- get_appName.func_reference(app) .SH SYNOPSIS diff --git a/man/get_appName.obj.1 b/man/get_appName.obj.1 index 90dad8c..b2d8251 100644 --- a/man/get_appName.obj.1 +++ b/man/get_appName.obj.1 @@ -1,4 +1,4 @@ -.TH GET_APPNAME.OBJ 1 2024-Jul "" "Get app name from the generated analysis app module" +.TH GET_APPNAME.OBJ 1 2024-Aug "" "Get app name from the generated analysis app module" .SH NAME get_appName.obj \- get_appName.obj(app) .SH SYNOPSIS diff --git a/man/get_app_name.1 b/man/get_app_name.1 index 4a52cd8..33d436f 100644 --- a/man/get_app_name.1 +++ b/man/get_app_name.1 @@ -1,4 +1,4 @@ -.TH GET_APP_NAME 1 2024-Jul "" "Helper function for get app name" +.TH GET_APP_NAME 1 2024-Aug "" "Helper function for get app name" .SH NAME get_app_name \- get_app_name(app) .SH SYNOPSIS diff --git a/man/get_config.1 b/man/get_config.1 index a20a67e..4ea7c88 100644 --- a/man/get_config.1 +++ b/man/get_config.1 @@ -1,4 +1,4 @@ -.TH GET_CONFIG 1 2024-Jul "" "get user parameter value inside current workflow context environment" +.TH GET_CONFIG 1 2024-Aug "" "get user parameter value inside current workflow context environment" .SH NAME get_config \- get_config(name, default = NULL) diff --git a/man/get_functionName.1 b/man/get_functionName.1 index abce88f..88ee2aa 100644 --- a/man/get_functionName.1 +++ b/man/get_functionName.1 @@ -1,4 +1,4 @@ -.TH GET_FUNCTIONNAME 1 2024-Jul "" "get function name" +.TH GET_FUNCTIONNAME 1 2024-Aug "" "get function name" .SH NAME get_functionName \- get_functionName(f) .SH SYNOPSIS diff --git a/man/get_timestamp.1 b/man/get_timestamp.1 index 764a366..08611db 100644 --- a/man/get_timestamp.1 +++ b/man/get_timestamp.1 @@ -1,4 +1,4 @@ -.TH GET_TIMESTAMP 1 2024-Jul "" "get a character vector of current timespan" +.TH GET_TIMESTAMP 1 2024-Aug "" "get a character vector of current timespan" .SH NAME get_timestamp \- get_timestamp() .SH SYNOPSIS diff --git a/man/has_cachefile.1 b/man/has_cachefile.1 index 7c3ee3f..dc5706f 100644 --- a/man/has_cachefile.1 +++ b/man/has_cachefile.1 @@ -1,4 +1,4 @@ -.TH HAS_CACHEFILE 1 2024-Jul "" "check the cache file is exists or not" +.TH HAS_CACHEFILE 1 2024-Aug "" "check the cache file is exists or not" .SH NAME has_cachefile \- has_cachefile(filepath) .SH SYNOPSIS diff --git a/man/hook.1 b/man/hook.1 index ceaa485..cd5fe57 100644 --- a/man/hook.1 +++ b/man/hook.1 @@ -1,4 +1,4 @@ -.TH HOOK 1 2024-Jul "" "Add workflow app component into the registry" +.TH HOOK 1 2024-Aug "" "Add workflow app component into the registry" .SH NAME hook \- hook(app) .SH SYNOPSIS diff --git a/man/init_context.1 b/man/init_context.1 index 9b79a99..1903efa 100644 --- a/man/init_context.1 +++ b/man/init_context.1 @@ -1,4 +1,4 @@ -.TH INIT_CONTEXT 1 2024-Jul "" "This function should be call at first" +.TH INIT_CONTEXT 1 2024-Aug "" "This function should be call at first" .SH NAME init_context \- init_context( outputdir = './') diff --git a/man/pull_configs.1 b/man/pull_configs.1 index 5aa65a1..79d78f8 100644 --- a/man/pull_configs.1 +++ b/man/pull_configs.1 @@ -1,4 +1,4 @@ -.TH PULL_CONFIGS 1 2024-Jul "" "pull all configuration value from workflow registry" +.TH PULL_CONFIGS 1 2024-Aug "" "pull all configuration value from workflow registry" .SH NAME pull_configs \- pull_configs() .SH SYNOPSIS diff --git a/man/run.1 b/man/run.1 index 13a8108..04baa46 100644 --- a/man/run.1 +++ b/man/run.1 @@ -1,4 +1,4 @@ -.TH RUN 1 2024-Jul "" "Call this function to start run workflow" +.TH RUN 1 2024-Aug "" "Call this function to start run workflow" .SH NAME run \- run( registry = NULL, diff --git a/man/set_config.1 b/man/set_config.1 index 55e3b26..f459cb8 100644 --- a/man/set_config.1 +++ b/man/set_config.1 @@ -1,4 +1,4 @@ -.TH SET_CONFIG 1 2024-Jul "" "Set user parameters to the workflow context" +.TH SET_CONFIG 1 2024-Aug "" "Set user parameters to the workflow context" .SH NAME set_config \- set_config( configs = 'list'()) diff --git a/man/set_dependency.1 b/man/set_dependency.1 index a432092..07b9802 100644 --- a/man/set_dependency.1 +++ b/man/set_dependency.1 @@ -1,4 +1,4 @@ -.TH SET_DEPENDENCY 1 2024-Jul "" "function for create application dependency data" +.TH SET_DEPENDENCY 1 2024-Aug "" "function for create application dependency data" .SH NAME set_dependency \- set_dependency( context.env = 'list'(), diff --git a/man/set_disable.1 b/man/set_disable.1 index ef9c830..05ca8ba 100644 --- a/man/set_disable.1 +++ b/man/set_disable.1 @@ -1,4 +1,4 @@ -.TH SET_DISABLE 1 2024-Jul "" "Set workflow application disable flag" +.TH SET_DISABLE 1 2024-Aug "" "Set workflow application disable flag" .SH NAME set_disable \- set_disable(app, flag = TRUE) diff --git a/man/summary.1 b/man/summary.1 index f189f8c..eb780cb 100644 --- a/man/summary.1 +++ b/man/summary.1 @@ -1,4 +1,4 @@ -.TH SUMMARY 1 2024-Jul "" "Inspect the workflow analysis modules" +.TH SUMMARY 1 2024-Aug "" "Inspect the workflow analysis modules" .SH NAME summary \- summary() .SH SYNOPSIS diff --git a/man/tabulate_workflow_summary.1 b/man/tabulate_workflow_summary.1 index 01d828a..9eb07b6 100644 --- a/man/tabulate_workflow_summary.1 +++ b/man/tabulate_workflow_summary.1 @@ -1,4 +1,4 @@ -.TH TABULATE_WORKFLOW_SUMMARY 1 2024-Jul "" "Extract the workflow analysis contents" +.TH TABULATE_WORKFLOW_SUMMARY 1 2024-Aug "" "Extract the workflow analysis contents" .SH NAME tabulate_workflow_summary \- tabulate_workflow_summary(pool) .SH SYNOPSIS diff --git a/man/throw_err.1 b/man/throw_err.1 index dcb9077..6a3fcc1 100644 --- a/man/throw_err.1 +++ b/man/throw_err.1 @@ -1,4 +1,4 @@ -.TH THROW_ERR 1 2024-Jul "" "echo error message on the screen and then crash the workflow" +.TH THROW_ERR 1 2024-Aug "" "echo error message on the screen and then crash the workflow" .SH NAME throw_err \- throw_err(msg) .SH SYNOPSIS diff --git a/man/use_cache.1 b/man/use_cache.1 index 1d04c33..f26727b 100644 --- a/man/use_cache.1 +++ b/man/use_cache.1 @@ -1,4 +1,4 @@ -.TH USE_CACHE 1 2024-Jul "" "Work with cache file" +.TH USE_CACHE 1 2024-Aug "" "Work with cache file" .SH NAME use_cache \- use_cache(filepath, create) .SH SYNOPSIS diff --git a/man/workdir_root.1 b/man/workdir_root.1 index a7e8bcf..ee1b6bc 100644 --- a/man/workdir_root.1 +++ b/man/workdir_root.1 @@ -1,4 +1,4 @@ -.TH WORKDIR_ROOT 1 2024-Jul "" "Get workspace root directory" +.TH WORKDIR_ROOT 1 2024-Aug "" "Get workspace root directory" .SH NAME workdir_root \- workdir_root() .SH SYNOPSIS diff --git a/man/workfile.1 b/man/workfile.1 index ca2c401..a04a3e1 100644 --- a/man/workfile.1 +++ b/man/workfile.1 @@ -1,4 +1,4 @@ -.TH WORKFILE 1 2024-Jul "" "Construct of the file path inside an app workspace" +.TH WORKFILE 1 2024-Aug "" "Construct of the file path inside an app workspace" .SH NAME workfile \- workfile(app, relpath = NULL) diff --git a/man/workspace.1 b/man/workspace.1 index 48764b6..42500e2 100644 --- a/man/workspace.1 +++ b/man/workspace.1 @@ -1,4 +1,4 @@ -.TH WORKSPACE 1 2024-Jul "" "get app workspace location" +.TH WORKSPACE 1 2024-Aug "" "get app workspace location" .SH NAME workspace \- workspace(app) .SH SYNOPSIS diff --git a/vignettes/R/docs/.get_context.html b/vignettes/R/docs/.get_context.html index 342611c..f0d63c3 100644 --- a/vignettes/R/docs/.get_context.html +++ b/vignettes/R/docs/.get_context.html @@ -2,7 +2,7 @@ - <p>get current workflow environment context</p> + get current workflow environment context @@ -18,7 +18,7 @@ -

get current workflow environment context

+

get current workflow environment context

Description

diff --git a/vignettes/R/docs/.internal_call.html b/vignettes/R/docs/.internal_call.html index 2ddeef6..88a3bc3 100644 --- a/vignettes/R/docs/.internal_call.html +++ b/vignettes/R/docs/.internal_call.html @@ -2,7 +2,7 @@ - <p>Invoke an analysis application</p> + Invoke an analysis application @@ -18,7 +18,7 @@ -

Invoke an analysis application

+

Invoke an analysis application

Description

diff --git a/vignettes/R/docs/.onLoad.html b/vignettes/R/docs/.onLoad.html index 6d78e40..5c5ba92 100644 --- a/vignettes/R/docs/.onLoad.html +++ b/vignettes/R/docs/.onLoad.html @@ -2,7 +2,7 @@ - <p>.onLoad</p> + .onLoad @@ -18,7 +18,7 @@ -

.onLoad

+

.onLoad

Description

diff --git a/vignettes/R/docs/__build_app.html b/vignettes/R/docs/__build_app.html index 74fdabd..4fda99d 100644 --- a/vignettes/R/docs/__build_app.html +++ b/vignettes/R/docs/__build_app.html @@ -2,7 +2,7 @@ - <p>Build workflow app object</p> + Build workflow app object @@ -18,7 +18,7 @@ -

Build workflow app object

+

Build workflow app object

Description

diff --git a/vignettes/R/docs/__runImpl.html b/vignettes/R/docs/__runImpl.html index f578979..8dfc1d9 100644 --- a/vignettes/R/docs/__runImpl.html +++ b/vignettes/R/docs/__runImpl.html @@ -2,7 +2,7 @@ - <p>An internal function for start the workflow</p> + An internal function for start the workflow @@ -18,7 +18,7 @@ -

An internal function for start the workflow

+

An internal function for start the workflow

Description

diff --git a/vignettes/R/docs/__workfile_uri_parser.html b/vignettes/R/docs/__workfile_uri_parser.html index 2e1a050..0cfb0d4 100644 --- a/vignettes/R/docs/__workfile_uri_parser.html +++ b/vignettes/R/docs/__workfile_uri_parser.html @@ -2,7 +2,7 @@ - <p>parse the workfile expression</p> + parse the workfile expression @@ -18,7 +18,7 @@ -

parse the workfile expression

+

parse the workfile expression

Description

diff --git a/vignettes/R/docs/__workfiles.html b/vignettes/R/docs/__workfiles.html index 209dabc..0b99d90 100644 --- a/vignettes/R/docs/__workfiles.html +++ b/vignettes/R/docs/__workfiles.html @@ -2,7 +2,7 @@ - <p>parse the workfile expression</p> + parse the workfile expression @@ -18,7 +18,7 @@ -

parse the workfile expression

+

parse the workfile expression

Description

diff --git a/vignettes/R/docs/app.html b/vignettes/R/docs/app.html index 6ec78a7..c007535 100644 --- a/vignettes/R/docs/app.html +++ b/vignettes/R/docs/app.html @@ -2,7 +2,7 @@ - <p>Analysis app constructor</p> + Analysis app constructor @@ -18,7 +18,7 @@ -

Analysis app constructor

+

Analysis app constructor

Description

diff --git a/vignettes/R/docs/app_check.delegate.html b/vignettes/R/docs/app_check.delegate.html index 984ebeb..bb9db06 100644 --- a/vignettes/R/docs/app_check.delegate.html +++ b/vignettes/R/docs/app_check.delegate.html @@ -2,7 +2,7 @@ - <p>Check the function signature of the app function</p> + Check the function signature of the app function @@ -18,7 +18,7 @@ -

Check the function signature of the app function

+

Check the function signature of the app function

Description

diff --git a/vignettes/R/docs/app_check.signature.html b/vignettes/R/docs/app_check.signature.html index a7395af..4b51b80 100644 --- a/vignettes/R/docs/app_check.signature.html +++ b/vignettes/R/docs/app_check.signature.html @@ -2,7 +2,7 @@ - <p>check of the required app slot</p> + check of the required app slot @@ -18,7 +18,7 @@ -

check of the required app slot

+

check of the required app slot

Description

diff --git a/vignettes/R/docs/check_dependency.context_env.html b/vignettes/R/docs/check_dependency.context_env.html index dce34f2..3877de3 100644 --- a/vignettes/R/docs/check_dependency.context_env.html +++ b/vignettes/R/docs/check_dependency.context_env.html @@ -2,7 +2,7 @@ - <p>Check of the required environment symbols</p> + Check of the required environment symbols @@ -18,7 +18,7 @@ -

Check of the required environment symbols

+

Check of the required environment symbols

Description

diff --git a/vignettes/R/docs/check_dependency.html b/vignettes/R/docs/check_dependency.html index caffd05..f72e48c 100644 --- a/vignettes/R/docs/check_dependency.html +++ b/vignettes/R/docs/check_dependency.html @@ -2,7 +2,7 @@ - <p>Check of the analysis app dependency</p> + Check of the analysis app dependency @@ -18,7 +18,7 @@ -

Check of the analysis app dependency

+

Check of the analysis app dependency

Description

diff --git a/vignettes/R/docs/check_dependency.localfiles.html b/vignettes/R/docs/check_dependency.localfiles.html index 62f6891..e7ddbee 100644 --- a/vignettes/R/docs/check_dependency.localfiles.html +++ b/vignettes/R/docs/check_dependency.localfiles.html @@ -2,7 +2,7 @@ - <p>Check for the upstream file dependency</p> + Check for the upstream file dependency @@ -18,7 +18,7 @@ -

Check for the upstream file dependency

+

Check for the upstream file dependency

Description

diff --git a/vignettes/R/docs/create_memory_context.html b/vignettes/R/docs/create_memory_context.html index 19e60b9..30f2d70 100644 --- a/vignettes/R/docs/create_memory_context.html +++ b/vignettes/R/docs/create_memory_context.html @@ -2,7 +2,7 @@ - <p>create an in-memory context object just used for run debug</p> + create an in-memory context object just used for run debug @@ -18,7 +18,7 @@ -

create an in-memory context object just used for run debug

+

create an in-memory context object just used for run debug

Description

diff --git a/vignettes/R/docs/definePipeline.html b/vignettes/R/docs/definePipeline.html index 43b5b85..45092b4 100644 --- a/vignettes/R/docs/definePipeline.html +++ b/vignettes/R/docs/definePipeline.html @@ -2,7 +2,7 @@ - <p>Create a custom pipeline workflow execute sequence</p> + Create a custom pipeline workflow execute sequence @@ -18,7 +18,7 @@ -

Create a custom pipeline workflow execute sequence

+

Create a custom pipeline workflow execute sequence

Description

diff --git a/vignettes/R/docs/dependency.context_env_missing.html b/vignettes/R/docs/dependency.context_env_missing.html index d377e13..a633020 100644 --- a/vignettes/R/docs/dependency.context_env_missing.html +++ b/vignettes/R/docs/dependency.context_env_missing.html @@ -2,7 +2,7 @@ - <p>Generate the error message for missing context symbols</p> + Generate the error message for missing context symbols @@ -18,7 +18,7 @@ -

Generate the error message for missing context symbols

+

Generate the error message for missing context symbols

Description

diff --git a/vignettes/R/docs/dependency.workfiles_missing.html b/vignettes/R/docs/dependency.workfiles_missing.html index 4d23cc5..92d2a44 100644 --- a/vignettes/R/docs/dependency.workfiles_missing.html +++ b/vignettes/R/docs/dependency.workfiles_missing.html @@ -2,7 +2,7 @@ - <p>Generate the error message for the missing required work files</p> + Generate the error message for the missing required work files @@ -18,7 +18,7 @@ -

Generate the error message for the missing required work files

+

Generate the error message for the missing required work files

Description

diff --git a/vignettes/R/docs/dependency_analysis.html b/vignettes/R/docs/dependency_analysis.html index ba5eccd..bc77ef9 100644 --- a/vignettes/R/docs/dependency_analysis.html +++ b/vignettes/R/docs/dependency_analysis.html @@ -2,7 +2,7 @@ - <p>dependency_analysis</p> + dependency_analysis @@ -18,7 +18,7 @@ -

dependency_analysis

+

dependency_analysis

Description

diff --git a/vignettes/R/docs/dependency_graph.html b/vignettes/R/docs/dependency_graph.html index 7ffee8a..1ead4d0 100644 --- a/vignettes/R/docs/dependency_graph.html +++ b/vignettes/R/docs/dependency_graph.html @@ -2,7 +2,7 @@ - <p>try to extract the dependency graph from the application modules</p> + try to extract the dependency graph from the application modules @@ -18,7 +18,7 @@ -

try to extract the dependency graph from the application modules

+

try to extract the dependency graph from the application modules

Description

diff --git a/vignettes/R/docs/echo_warning.html b/vignettes/R/docs/echo_warning.html index d3786a0..a85f0d5 100644 --- a/vignettes/R/docs/echo_warning.html +++ b/vignettes/R/docs/echo_warning.html @@ -2,7 +2,7 @@ - <p>print warning message on the screen and the log file</p> + print warning message on the screen and the log file @@ -18,7 +18,7 @@ -

print warning message on the screen and the log file

+

print warning message on the screen and the log file

Description

diff --git a/vignettes/R/docs/extract_workflow_vertex.html b/vignettes/R/docs/extract_workflow_vertex.html index db9a444..64c46ee 100644 --- a/vignettes/R/docs/extract_workflow_vertex.html +++ b/vignettes/R/docs/extract_workflow_vertex.html @@ -2,7 +2,7 @@ - <p>extract<em>workflow</em>vertex</p> + extract_workflow_vertex @@ -18,7 +18,7 @@ -

extractworkflowvertex

+

extract_workflow_vertex

Description

diff --git a/vignettes/R/docs/filepath_safe.html b/vignettes/R/docs/filepath_safe.html index 586b2f5..369dcf5 100644 --- a/vignettes/R/docs/filepath_safe.html +++ b/vignettes/R/docs/filepath_safe.html @@ -2,7 +2,7 @@ - <p>Create the file path safely</p> + Create the file path safely @@ -18,7 +18,7 @@ -

Create the file path safely

+

Create the file path safely

Description

diff --git a/vignettes/R/docs/finalize.html b/vignettes/R/docs/finalize.html index 074d425..95f0d69 100644 --- a/vignettes/R/docs/finalize.html +++ b/vignettes/R/docs/finalize.html @@ -2,7 +2,7 @@ - <p>Mark end of the analysis workflow</p> + Mark end of the analysis workflow @@ -18,7 +18,7 @@ -

Mark end of the analysis workflow

+

Mark end of the analysis workflow

Description

diff --git a/vignettes/R/docs/get_appName.func_reference.html b/vignettes/R/docs/get_appName.func_reference.html index 47fdbce..77b94ff 100644 --- a/vignettes/R/docs/get_appName.func_reference.html +++ b/vignettes/R/docs/get_appName.func_reference.html @@ -2,7 +2,7 @@ - <p>get app name from the analysis function as reference</p> + get app name from the analysis function as reference @@ -18,7 +18,7 @@ -

get app name from the analysis function as reference

+

get app name from the analysis function as reference

Description

diff --git a/vignettes/R/docs/get_appName.obj.html b/vignettes/R/docs/get_appName.obj.html index d5c5eb8..5217d4f 100644 --- a/vignettes/R/docs/get_appName.obj.html +++ b/vignettes/R/docs/get_appName.obj.html @@ -2,7 +2,7 @@ - <p>Get app name from the generated analysis app module</p> + Get app name from the generated analysis app module @@ -18,7 +18,7 @@ -

Get app name from the generated analysis app module

+

Get app name from the generated analysis app module

Description

diff --git a/vignettes/R/docs/get_app_name.html b/vignettes/R/docs/get_app_name.html index 2ba6c81..5ce104f 100644 --- a/vignettes/R/docs/get_app_name.html +++ b/vignettes/R/docs/get_app_name.html @@ -2,7 +2,7 @@ - <p>Helper function for get app name</p> + Helper function for get app name @@ -18,7 +18,7 @@ -

Helper function for get app name

+

Helper function for get app name

Description

diff --git a/vignettes/R/docs/get_config.html b/vignettes/R/docs/get_config.html index 4f34d88..bf38d9b 100644 --- a/vignettes/R/docs/get_config.html +++ b/vignettes/R/docs/get_config.html @@ -2,7 +2,7 @@ - <p>get user parameter value inside current workflow context environment</p> + get user parameter value inside current workflow context environment @@ -18,7 +18,7 @@ -

get user parameter value inside current workflow context environment

+

get user parameter value inside current workflow context environment

Description

diff --git a/vignettes/R/docs/get_functionName.html b/vignettes/R/docs/get_functionName.html index 227982a..d9d77dc 100644 --- a/vignettes/R/docs/get_functionName.html +++ b/vignettes/R/docs/get_functionName.html @@ -2,7 +2,7 @@ - <p>get function name</p> + get function name @@ -18,7 +18,7 @@ -

get function name

+

get function name

Description

diff --git a/vignettes/R/docs/get_timestamp.html b/vignettes/R/docs/get_timestamp.html index b245c65..82b2c24 100644 --- a/vignettes/R/docs/get_timestamp.html +++ b/vignettes/R/docs/get_timestamp.html @@ -2,7 +2,7 @@ - <p>get a character vector of current timespan</p> + get a character vector of current timespan @@ -18,7 +18,7 @@ -

get a character vector of current timespan

+

get a character vector of current timespan

Description

diff --git a/vignettes/R/docs/has_cachefile.html b/vignettes/R/docs/has_cachefile.html index b4f9d21..4dd08e8 100644 --- a/vignettes/R/docs/has_cachefile.html +++ b/vignettes/R/docs/has_cachefile.html @@ -2,7 +2,7 @@ - <p>check the cache file is exists or not</p> + check the cache file is exists or not @@ -18,7 +18,7 @@ -

check the cache file is exists or not

+

check the cache file is exists or not

Description

diff --git a/vignettes/R/docs/hook.html b/vignettes/R/docs/hook.html index 317401a..668b223 100644 --- a/vignettes/R/docs/hook.html +++ b/vignettes/R/docs/hook.html @@ -2,7 +2,7 @@ - <p>Add workflow app component into the registry</p> + Add workflow app component into the registry @@ -18,7 +18,7 @@ -

Add workflow app component into the registry

+

Add workflow app component into the registry

Description

diff --git a/vignettes/R/docs/init_context.html b/vignettes/R/docs/init_context.html index 3afe27c..1a01806 100644 --- a/vignettes/R/docs/init_context.html +++ b/vignettes/R/docs/init_context.html @@ -2,7 +2,7 @@ - <p>This function should be call at first</p> + This function should be call at first @@ -18,7 +18,7 @@ -

This function should be call at first

+

This function should be call at first

Description

diff --git a/vignettes/R/docs/pull_configs.html b/vignettes/R/docs/pull_configs.html index 48e2b41..0a89e0e 100644 --- a/vignettes/R/docs/pull_configs.html +++ b/vignettes/R/docs/pull_configs.html @@ -2,7 +2,7 @@ - <p>pull all configuration value from workflow registry</p> + pull all configuration value from workflow registry @@ -18,7 +18,7 @@ -

pull all configuration value from workflow registry

+

pull all configuration value from workflow registry

Description

diff --git a/vignettes/R/docs/run.html b/vignettes/R/docs/run.html index 10886a1..70517cd 100644 --- a/vignettes/R/docs/run.html +++ b/vignettes/R/docs/run.html @@ -2,7 +2,7 @@ - <p>Call this function to start run workflow</p> + Call this function to start run workflow @@ -18,7 +18,7 @@ -

Call this function to start run workflow

+

Call this function to start run workflow

Description

diff --git a/vignettes/R/docs/set_config.html b/vignettes/R/docs/set_config.html index 6aca29c..0e73fc4 100644 --- a/vignettes/R/docs/set_config.html +++ b/vignettes/R/docs/set_config.html @@ -2,7 +2,7 @@ - <p>Set user parameters to the workflow context</p> + Set user parameters to the workflow context @@ -18,7 +18,7 @@ -

Set user parameters to the workflow context

+

Set user parameters to the workflow context

Description

diff --git a/vignettes/R/docs/set_dependency.html b/vignettes/R/docs/set_dependency.html index f1bb9d8..9ec4fc8 100644 --- a/vignettes/R/docs/set_dependency.html +++ b/vignettes/R/docs/set_dependency.html @@ -2,7 +2,7 @@ - <p>function for create application dependency data</p> + function for create application dependency data @@ -18,7 +18,7 @@ -

function for create application dependency data

+

function for create application dependency data

Description

diff --git a/vignettes/R/docs/set_disable.html b/vignettes/R/docs/set_disable.html index d668387..0b4c70a 100644 --- a/vignettes/R/docs/set_disable.html +++ b/vignettes/R/docs/set_disable.html @@ -2,7 +2,7 @@ - <p>Set workflow application disable flag</p> + Set workflow application disable flag @@ -18,7 +18,7 @@ -

Set workflow application disable flag

+

Set workflow application disable flag

Description

diff --git a/vignettes/R/docs/summary.html b/vignettes/R/docs/summary.html index f958d43..f6b0078 100644 --- a/vignettes/R/docs/summary.html +++ b/vignettes/R/docs/summary.html @@ -2,7 +2,7 @@ - <p>Inspect the workflow analysis modules</p> + Inspect the workflow analysis modules @@ -18,7 +18,7 @@ -

Inspect the workflow analysis modules

+

Inspect the workflow analysis modules

Description

diff --git a/vignettes/R/docs/tabulate_workflow_summary.html b/vignettes/R/docs/tabulate_workflow_summary.html index 271feec..c4b0bf8 100644 --- a/vignettes/R/docs/tabulate_workflow_summary.html +++ b/vignettes/R/docs/tabulate_workflow_summary.html @@ -2,7 +2,7 @@ - <p>Extract the workflow analysis contents</p> + Extract the workflow analysis contents @@ -18,7 +18,7 @@ -

Extract the workflow analysis contents

+

Extract the workflow analysis contents

Description

diff --git a/vignettes/R/docs/throw_err.html b/vignettes/R/docs/throw_err.html index 9bb43be..60c03e5 100644 --- a/vignettes/R/docs/throw_err.html +++ b/vignettes/R/docs/throw_err.html @@ -2,7 +2,7 @@ - <p>echo error message on the screen and then crash the workflow</p> + echo error message on the screen and then crash the workflow @@ -18,7 +18,7 @@ -

echo error message on the screen and then crash the workflow

+

echo error message on the screen and then crash the workflow

Description

diff --git a/vignettes/R/docs/use_cache.html b/vignettes/R/docs/use_cache.html index d686257..157a2a8 100644 --- a/vignettes/R/docs/use_cache.html +++ b/vignettes/R/docs/use_cache.html @@ -2,7 +2,7 @@ - <p>Work with cache file</p> + Work with cache file @@ -18,7 +18,7 @@ -

Work with cache file

+

Work with cache file

Description

diff --git a/vignettes/R/docs/workdir_root.html b/vignettes/R/docs/workdir_root.html index 35651a2..23e809b 100644 --- a/vignettes/R/docs/workdir_root.html +++ b/vignettes/R/docs/workdir_root.html @@ -2,7 +2,7 @@ - <p>Get workspace root directory</p> + Get workspace root directory @@ -18,7 +18,7 @@ -

Get workspace root directory

+

Get workspace root directory

Description

diff --git a/vignettes/R/docs/workfile.html b/vignettes/R/docs/workfile.html index 73dedef..ebc3f10 100644 --- a/vignettes/R/docs/workfile.html +++ b/vignettes/R/docs/workfile.html @@ -2,7 +2,7 @@ - <p>Construct of the file path inside an app workspace</p> + Construct of the file path inside an app workspace @@ -18,7 +18,7 @@ -

Construct of the file path inside an app workspace

+

Construct of the file path inside an app workspace

Description

diff --git a/vignettes/R/docs/workspace.html b/vignettes/R/docs/workspace.html index 26256e2..1b23b07 100644 --- a/vignettes/R/docs/workspace.html +++ b/vignettes/R/docs/workspace.html @@ -2,7 +2,7 @@ - <p>get app workspace location</p> + get app workspace location @@ -18,7 +18,7 @@ -

get app workspace location

+

get app workspace location

Description

diff --git a/vignettes/index.html b/vignettes/index.html index 0264e78..1c9ca74 100644 --- a/vignettes/index.html +++ b/vignettes/index.html @@ -1,4 +1,9 @@ -
Package: WorkflowRender
+
+Compose the data analysis workflow
+
+
+
Compose the data analysis workflow

+
Package: WorkflowRender
 Type: Package
 Title: Compose the data analysis workflow
 Version: 0.1.0
@@ -60,3 +65,4 @@ 
R Package Symbols

 
  • throw_err
    • 
 
  • get_timestamp
    • 
 
+
diff --git a/vignettes/keywords.html b/vignettes/keywords.html
index 4cbee0c..f480841 100644
--- a/vignettes/keywords.html
+++ b/vignettes/keywords.html
@@ -1,2 +1,3 @@
+
    Keyword and Topics
    
+
    Symbols that has the relationship of share the same keywords and topics.
    
 
-»¿
\ No newline at end of file