R: Programmatic Interface to 'OpenM++'

# Programmatic Interface to 'OpenM++'

## Documentation for package ‘openmpp’ version 0.0.2

- DESCRIPTION file
- Package NEWS
- Package README

## Help Pages

A C D G I L M N O P R S T U

## -- A --

admin_cleanup_log | OpenM++ Administrative Tasks
admin_cleanup_logs | OpenM++ Administrative Tasks
admin_database_cleanup | OpenM++ Administrative Tasks
admin_database_close | OpenM++ Administrative Tasks
admin_database_open | OpenM++ Administrative Tasks
admin_jobs_pause | OpenM++ Administrative Tasks
admin_jobs_pause_all | OpenM++ Administrative Tasks
admin_models_close | OpenM++ Administrative Tasks
admin_models_refresh | OpenM++ Administrative Tasks
admin_model_delete | OpenM++ Administrative Tasks
admin_service_shutdown | OpenM++ Administrative Tasks

## -- C --

copy_param_run_to_workset | Update Workset Metadata
copy_param_workset_to_workset | Update Workset Metadata
create_scenario | Manage Model Scenarios
create_task | Update Modeling Tasks
create_user_files_folder | Manage OpenM++ User Files
create_workset | Manage Model Scenarios

## -- D --

delete_download_files | Download Model, Model Run Results, or Input Parameters
delete_download_files_async | Download Model, Model Run Results, or Input Parameters
delete_job_hist | OpenM++ Model Run Jobs and Service State
delete_model_profile | Update Model Profile
delete_model_profile_opt | Update Model Profile
delete_model_run | Update Model Runs
delete_model_runs | Update Model Runs
delete_run | Update Model Runs
delete_runs | Update Model Runs
delete_scenario | Update Workset Metadata
delete_task | Update Modeling Tasks
delete_upload_files | Upload Model Runs or Worksets
delete_upload_files_async | Upload Model Runs or Worksets
delete_user_files | Manage OpenM++ User Files
delete_user_files_all | Manage OpenM++ User Files
delete_user_views | Manage OpenM++ User Settings
delete_workset | Update Workset Metadata
delete_workset_param | Update Workset Metadata

## -- G --

get_active_job_state | OpenM++ Model Run Jobs and Service State
get_disk_use | OpenM++ Model Run Jobs and Service State
get_download_filetree | Download Model, Model Run Results, or Input Parameters
get_download_log | Download Model, Model Run Results, or Input Parameters
get_download_logs_all | Download Model, Model Run Results, or Input Parameters
get_download_logs_model | Download Model, Model Run Results, or Input Parameters
get_hist_job_state | OpenM++ Model Run Jobs and Service State
get_model | Model Metadata
get_models | Model Metadata
get_models_list | Model Metadata
get_model_lang_list | Model Extras
get_model_profile | Model Extras
get_model_profile_list | Model Extras
get_model_run | Model Run Results Metadata
get_model_runs | Model Run Results Metadata
get_model_runs_list | Model Run Results Metadata
get_model_run_list_status | Model Run Results Metadata
get_model_run_state | Run Models and Monitor Progress
get_model_run_status | Model Run Results Metadata
get_model_run_status_compl | Model Run Results Metadata
get_model_run_status_first | Model Run Results Metadata
get_model_run_status_last | Model Run Results Metadata
get_model_task | Modeling Task Metadata
get_model_tasks | Modeling Task Metadata
get_model_tasks_list | Modeling Task Metadata
get_model_task_hist | Modeling Task Metadata
get_model_task_run_compl | Modeling Task Metadata
get_model_task_run_first | Modeling Task Metadata
get_model_task_run_last | Modeling Task Metadata
get_model_task_run_list_status | Modeling Task Metadata
get_model_task_status | Modeling Task Metadata
get_model_task_worksets | Modeling Task Metadata
get_model_word_list | Model Extras
get_queue_job_state | OpenM++ Model Run Jobs and Service State
get_run | Model Run Results Metadata
get_runs | Model Run Results Metadata
get_run_microdata | Read Run Microdata
get_run_microdata_csv | Read Run Microdata
get_run_param | Read Parameters
get_run_param_csv | Read Parameters
get_run_state | Run Models and Monitor Progress
get_run_status | Model Run Results Metadata
get_run_table | Read Output Tables
get_run_table_acc_csv | Read Output Tables
get_run_table_calc_csv | Read Output Tables
get_run_table_comparison_csv | Read Output Tables
get_run_table_csv | Read Output Tables
get_scenarios | Model Workset Metadata
get_service_config | OpenM++ Model Run Jobs and Service State
get_service_state | OpenM++ Model Run Jobs and Service State
get_upload_filetree | Upload Model Runs or Worksets
get_upload_log | Upload Model Runs or Worksets
get_upload_logs_all | Upload Model Runs or Worksets
get_upload_logs_model | Upload Model Runs or Worksets
get_user_files | Manage OpenM++ User Files
get_user_views | Manage OpenM++ User Settings
get_workset | Model Workset Metadata
get_worksets | Model Workset Metadata
get_worksets_list | Model Workset Metadata
get_workset_param | Read Parameters
get_workset_param_csv | Read Parameters
get_workset_status | Model Workset Metadata
get_workset_status_default | Model Workset Metadata

## -- I --

initiate_model_download | Download Model, Model Run Results, or Input Parameters
initiate_run_download | Download Model, Model Run Results, or Input Parameters
initiate_run_upload | Upload Model Runs or Worksets
initiate_workset_download | Download Model, Model Run Results, or Input Parameters
initiate_workset_upload | Upload Model Runs or Worksets
is_compatible | Are data frames compatible?

## -- L --

load_model | OpenM++ Model Class
load_model_run | OpenM++ ModelRun Class
load_model_runs | OpenM++ ModelRunSet Class
load_run | OpenM++ ModelRun Class
load_runs | OpenM++ ModelRunSet Class
load_scenario | OpenM++ Workset Class
load_workset | OpenM++ Workset Class

## -- M --

merge_param_run_to_workset | Update Workset Metadata
merge_param_workset_to_workset | Update Workset Metadata
merge_workset | Update Workset Metadata

## -- N --

new_workset | Update Workset Metadata

## -- O --

OpenMppModel | OpenM++ Model Class
OpenMppModelRun | OpenM++ ModelRun Class
OpenMppModelRunSet | OpenM++ ModelRunSet Class
OpenMppWorkset | OpenM++ Workset Class
opts_run | Run Configuration Options

## -- P --

print.OpenMppRunOpts | Run Configuration Options

## -- R --

refresh_disk_use | OpenM++ Model Run Jobs and Service State
replace_workset | Update Workset Metadata
run_model | Run Models and Monitor Progress

## -- S --

set_model_profile_opt | Update Model Profile
set_queue_job_pos | OpenM++ Model Run Jobs and Service State
set_user_views | Manage OpenM++ User Settings
set_workset_readonly | Update Workset Metadata
stop_model_run | Run Models and Monitor Progress
stop_run | Run Models and Monitor Progress

## -- T --

touch_model_profile | Update Model Profile

## -- U --

update_task | Update Modeling Tasks
update_workset_param | Update Workset Metadata
update_workset_param_csv | Update Workset Metadata
upload_user_files | Manage OpenM++ User Files
upload_workset_params | Update Workset Metadata
use_OpenMpp_CPAC | OpenM++ CPAC API Connection
use_OpenMpp_custom | OpenM++ Custom API Connection
use_OpenMpp_local | OpenM++ Local API Connection