admin_models_refresh {openmpp} | R Documentation |
OpenM++ Administrative Tasks
Description
Functions for performing administrative tasks. More information about the administrative API endpoints can be found at here.
Usage
admin_models_refresh()
admin_models_close()
admin_database_close(model)
admin_model_delete(model)
admin_database_open(path)
admin_database_cleanup(path, name = NULL, digest = NULL)
admin_cleanup_logs()
admin_cleanup_log(name)
admin_jobs_pause(pause)
admin_jobs_pause_all(pause)
admin_service_shutdown()
Arguments
model |
Model digest or model name. |
path |
Path to model database file relative to the |
name |
Model name. Optional for |
digest |
Model digest. Optional for |
pause |
Logical. Whether to pause or resume model runs queue processing. |
Details
To find the relative path
to a database file for cleanup with
admin_database_cleanup(path)
or opening a database file with
admin_database_open(path)
, users can run the get_models_list()
function to retrieve the list of model information and find the DbPath
list item. DbPath
is the relative path to the database file. You
must replace the forward-slashes in the relative path with asterisks.
Value
A list
or nothing, invisibly.
Examples
## Not run:
use_OpenMpp_local()
admin_models_refresh()
## End(Not run)