Package: montagu 0.6.1

Rich FitzJohn

montagu: Interface with 'montagu'

Client for interacting with the montagu API, and authentication with the montagu OrderlyWeb instance. This package is part of montagu.

Authors:Rich FitzJohn [aut, cre], Wes Hinsley [aut]

montagu_0.6.1.tar.gz
montagu_0.6.1.zip(r-4.5)montagu_0.6.1.zip(r-4.4)montagu_0.6.1.zip(r-4.3)
montagu_0.6.1.tgz(r-4.4-any)montagu_0.6.1.tgz(r-4.3-any)
montagu_0.6.1.tar.gz(r-4.5-noble)montagu_0.6.1.tar.gz(r-4.4-noble)
montagu_0.6.1.tgz(r-4.4-emscripten)montagu_0.6.1.tgz(r-4.3-emscripten)
montagu.pdf |montagu.html✨
montagu/json (API)
NEWS

# Install 'montagu' in R:
install.packages('montagu', repos = c('https://mrc-ide.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/vimc/montagu-r/issues

On CRAN:

3.48 score 2 stars 3 scripts 44 exports 22 dependencies

Last updated 5 years agofrom:3e9359af07 (on master). Checks:OK: 7. Indexed: no.

TargetResultDate
Doc / VignettesOKOct 31 2024
R-4.5-winOKOct 31 2024
R-4.5-linuxOKOct 31 2024
R-4.4-winOKOct 31 2024
R-4.4-macOKOct 31 2024
R-4.3-winOKOct 31 2024
R-4.3-macOKOct 31 2024

Exports:montagu_burden_estimate_set_clearmontagu_burden_estimate_set_closemontagu_burden_estimate_set_createmontagu_burden_estimate_set_datamontagu_burden_estimate_set_infomontagu_burden_estimate_set_outcome_datamontagu_burden_estimate_set_problemsmontagu_burden_estimate_set_uploadmontagu_burden_estimate_setsmontagu_central_burden_estimate_templatemontagu_coverage_datamontagu_coverage_infomontagu_current_estimate_set_infomontagu_current_estimate_set_problemsmontagu_demographic_datamontagu_demographics_listmontagu_diseasemontagu_diseasesmontagu_expectationmontagu_expectation_applicable_scenariosmontagu_expectation_countriesmontagu_expectation_outcomesmontagu_expectationsmontagu_modelmontagu_model_listmontagu_model_run_parameter_set_datamontagu_model_run_parameter_set_infomontagu_model_run_parameter_set_uploadmontagu_model_run_parameter_setsmontagu_modelling_groupmontagu_modelling_group_membersmontagu_modelling_groupsmontagu_modelsmontagu_orderlyweb_remotemontagu_scenario_problemsmontagu_scenario_statusmontagu_scenariosmontagu_servermontagu_server_global_default_setmontagu_server_global_listmontagu_stochastic_burden_estimate_templatemontagu_touchstone_versionsmontagu_touchstonesmontagu_touchstones_for_scenario

Dependencies:askpassclicrayoncurldigestgetPassgluehmshttrjsonlitelifecyclemimeopensslpkgconfigprettyunitsprogressR6rlangrstudioapistorrsysvctrs

Montagu API from R

VIMC Technical Team

Rendered frommontagu_user_guide.Rmdusingknitr::rmarkdownon Oct 31 2024.

Last update: 2019-10-08
Started: 2019-02-19

Readme and manuals

Help Manual

Help pageTopics
Deletes all uploaded rows from an incomplete burden estimate setmontagu_burden_estimate_set_clear
Closes a burden estimate set, marking it as complete.montagu_burden_estimate_set_close
Create a new burden estimate setmontagu_burden_estimate_set_create
Retrieves the data for a specific burden estimate set.montagu_burden_estimate_set_data
Retrieves information about a specific burden estimate set.montagu_burden_estimate_set_info
Retrieve data for a particular outcoe of a burden estimate set, aggregated across country and disaggregated by either age or year.montagu_burden_estimate_set_outcome_data
Retrieves information about a specific burden estimate set.montagu_burden_estimate_set_problems
Deletes all uploaded rows from an incomplete burden estimate setmontagu_burden_estimate_set_upload
Retrieves list of estimate sets for a group, touchstone and scenario.montagu_burden_estimate_sets
Get central burden estimate template for an expectationmontagu_central_burden_estimate_template
Retrieve coverage data for a scenario, touchstone and modelling group.montagu_coverage_data
Retrieve metadata for coverage sets for a particularly group, touchstone and scenario.montagu_coverage_info
Get information on current estimate set for a scenario.montagu_current_estimate_set_info
Retrieve list of any problems in current estimate set for a scenario.montagu_current_estimate_set_problems
Download demographic data for a given touchstone.montagu_demographic_data
List the demographic data available for a given touchstone.montagu_demographics_list
Retrieve disease with given id.montagu_disease
Retrieve list of all disease ids and names.montagu_diseases
Get information about an expectationmontagu_expectation
Get applicable scenarios for an expectationmontagu_expectation_applicable_scenarios
Get country list for an expectationmontagu_expectation_countries
Get expected outcomesmontagu_expectation_outcomes
Get expectations for a modelling group and touchstonemontagu_expectations
Retrieve model with given id.montagu_model
Retrieve list of models for a given modelling_group_id.montagu_model_list
Retrieve info about one model run parameter sets for a group and touchstonemontagu_model_run_parameter_set_data
Retrieve info about one model run parameter sets for a group and touchstonemontagu_model_run_parameter_set_info
Upload a model_run_parameter_set to Montagu.montagu_model_run_parameter_set_upload
Retrieve a list of model run parameter sets for a group and touchstonemontagu_model_run_parameter_sets
Retrieve modelling_group with given modelling_group_id.montagu_modelling_group
Retrieve list of members for a given modelling_group_id.montagu_modelling_group_members
Retrieve list of all modelling group ids and names.montagu_modelling_groups
Retrieve list of all model ids, names, citations and groups.montagu_models
orderly remote drivermontagu_orderlyweb_remote
Retrieve a list of any problems with a scenario.montagu_scenario_problems
Retrieve current status of a groups' scenario.montagu_scenario_status
Retrieve information about a scenariomontagu_scenarios
Create a handle to a montagu servermontagu_server
Set a global default montagu servermontagu_server_global_default_set
List known montagu serversmontagu_server_global_list
Get stochastic burden estimate template for an expectationmontagu_stochastic_burden_estimate_template
Retrieve list of all versions of a given touchstone.montagu_touchstone_versions
Retrieve touchstones a modelling group is responsible for.montagu_touchstones
Get touchstones that include this scenariomontagu_touchstones_for_scenario