Skip to content

Commit

Permalink
Better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattwarkentin committed Jan 5, 2024
1 parent 4811367 commit 4ddedac
Show file tree
Hide file tree
Showing 24 changed files with 42 additions and 42 deletions.
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Version: 0.0.0.9000
Authors@R:
person("Matthew T.", "Warkentin", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0001-8730-3511"))
Description: This package provides a programmatic interface to the OncoSimX
web-based platform. OncoSim is a free, web-based simulation tool that
can be used to evaluate cancer control strategies.
Description: This package provides a programmatic interface to the OpenM++
microsimulation platform and OncoSimX. OncoSimX is a free, web-based
simulation tool that can be used to evaluate cancer control strategies.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
Expand Down
2 changes: 1 addition & 1 deletion R/Microdata.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' OncoSimX Microdata
#' OpenM++ Microdata
#'
#' Functions for retrieving microdata from model runs.
#'
Expand Down
2 changes: 1 addition & 1 deletion R/Model.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' OncoSimX Models
#' OpenM++ Models
#'
#' Functions to get the complete list of models and load, run, or stop
#' a specific model.
Expand Down
2 changes: 1 addition & 1 deletion R/ModelExtras.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' OncoSimX Model Extras
#' OpenM++ Model Extras
#'
#' Functions for retrieving extra model information, including language lists,
#' word lists, profiles, and profile lists.
Expand Down
2 changes: 1 addition & 1 deletion R/ModelProfile.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' OncoSimX Model Profile
#' OpenM++ Model Profile
#'
#' Functions for creating, modifying, and deleting profiles and profile options.
#'
Expand Down
2 changes: 1 addition & 1 deletion R/ModelRun.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' OncoSimX Model Run
#' OpenM++ Model Run
#'
#' Functions to retrieve and delete model runs.
#'
Expand Down
2 changes: 1 addition & 1 deletion R/ModelTask.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' OncoSimX Model Task
#' OpenM++ Model Task
#'
#' Functions for getting creating, updating, retrieving, and deleting
#' model tasks.
Expand Down
2 changes: 1 addition & 1 deletion R/ModelWorkset.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' OncoSimX Model Worksets
#' OpenM++ Model Worksets
#'
#' Functions for creating, copying, merging, retrieving, and deleting
#' worksets.
Expand Down
6 changes: 3 additions & 3 deletions R/R6ClassModel.R
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ OpenMppModel <-
TablesInfo = NULL,

#' @description
#' Create a new OncoSimXModel object.
#' Create a new OpenMppModel object.
#' @param model Model digest or name.
#' @return A new `OncoSimXModel` object.
#' @return A new `OpenMppModel` object.
initialize = function(model) {
private$.set_model(model)
private$.set_model_metadata()
Expand All @@ -60,7 +60,7 @@ OpenMppModel <-
},

#' @description
#' Print a OncoSimXModel object.
#' Print a OpenMppModel object.
#' @param ... Not currently used.
#' @return Self, invisibly.
print = function(...) {
Expand Down
6 changes: 3 additions & 3 deletions R/R6ClassModelRun.R
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ OpenMppModelRun <-
Type = 'ModelRun',

#' @description
#' Create a new OncoSimXModelRun object.
#' Create a new OpenMppModelRun object.
#' @param model Model digest or name.
#' @param run Run digest, run stamp, or run name.
#' @return A new `OncoSimXModelRun` object.
#' @return A new `OpenMppModelRun` object.
initialize = function(model, run) {
super$initialize(model)
private$.set_run(model, run)
Expand All @@ -69,7 +69,7 @@ OpenMppModelRun <-
},

#' @description
#' Print a `OncoSimXModelRun` object.
#' Print a `OpenMppModelRun` object.
#' @param ... Not currently used.
#' @return Self, invisibly.
print = function(...) {
Expand Down
6 changes: 3 additions & 3 deletions R/R6ClassModelRunSet.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,18 @@ OpenMppModelRunSet <-
Tables = rlang::env(),

#' @description
#' Create a new OncoSimXModelRunSet object.
#' Create a new OpenMppModelRunSet object.
#' @param model Model digest or name.
#' @param runs Run digests, run stamps, or run names.
#' @return A new `OncoSimXModelSet` object.
#' @return A new `OpenMppModelRunSet` object.
initialize = function(model, runs) {
private$.set_runs(model, runs)
private$.set_runs_metadata()
private$.load_table_bindings()
},

#' @description
#' Print a `OncoSimXModelRunSet` object.
#' Print a `OpenMppModelRunSet` object.
#' @param ... Not currently used.
#' @return Self, invisibly.
print = function(...) {
Expand Down
6 changes: 3 additions & 3 deletions R/R6ClassWorkset.R
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ OpenMppWorkset <-
Parameters = rlang::env(),

#' @description
#' Create a new OncoSimXWorkset object.
#' Create a new OpenMppWorkset object.
#' @param model Model digest or name.
#' @param set Workset name.
#' @return A new `OncoSimXWorkset` object.
#' @return A new `OpenMppWorkset` object.
initialize = function(model, set) {
super$initialize(model)
private$.set_workset(model, set)
Expand All @@ -58,7 +58,7 @@ OpenMppWorkset <-
},

#' @description
#' Print a `OncoSimXWorkset` object.
#' Print a `OpenMppWorkset` object.
#' @param ... Not currently used.
#' @return Self, invisibly.
print = function(...) {
Expand Down
2 changes: 1 addition & 1 deletion man/get_model.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/get_model_lang_list.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/get_model_run.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/get_model_task.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/get_run_microdata.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/get_workset.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/load_model.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/load_model_run.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/load_model_runs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/load_workset.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/oncosimx-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/touch_model_profile.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4ddedac

Please sign in to comment.