From 25a530a2bcd388c3e6447afb9af3395cbcb66d10 Mon Sep 17 00:00:00 2001 From: Matt Warkentin Date: Thu, 24 Aug 2023 19:30:18 -0400 Subject: [PATCH] Minor README fixes --- README.Rmd | 8 ++++---- README.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.Rmd b/README.Rmd index 7c753e7..7e002e1 100644 --- a/README.Rmd +++ b/README.Rmd @@ -106,7 +106,7 @@ breast_default <- load_scenario('OncoSimX-breast', 'Default') breast_default ``` -Finally, we will load the base run for the Breast model +Finally, we will load the base run for the Breast model. ```{r} baserun_digest <- breast$run_list$RunDigest[[1]] @@ -120,7 +120,7 @@ We will create a new scenario based on the parameters from the `Default_first_ru create_scenario('OncoSimX-breast', 'MyNewScenario', baserun_digest) ``` -We will load the new scenario, copy over the `ProvincesOfInterest` parameter from the base run and extract it to a CSV file for editing +We will load the new scenario, copy over the `ProvincesOfInterest` parameter from the base run and extract it to a CSV file for editing. ```{r echo=FALSE} new_scenario <- load_scenario('OncoSimX-breast', 'MyNewScenario') @@ -138,7 +138,7 @@ We didn't make any changes to the parameters, but we will run the model anyway. new_scenario$run('ExampleRun', wait = TRUE) ``` -Now that our model run is complete, lets load it into memory +Now that our model run is complete, lets load it into memory. ```{r} example_run <- load_run('OncoSimX-breast', 'ExampleRun') @@ -151,7 +151,7 @@ We can now extract an output table from this model run using `$get_table()`. example_run$get_table('Breast_Cancer_Cases_Table') ``` -Great, we have create a new scenario, extracted some parameters to potentially modify, ran the model, and extracted output tables. In this last step, we will load multiple model runs into memory to compare them. +Great, we have created a new scenario, extracted some parameters to potentially modify, ran the model, and extracted output tables. In this last step, we will load multiple model runs into memory to compare them. ```{r} breast_runs <- load_runs('OncoSimX-breast', breast$run_list$RunDigest) diff --git a/README.md b/README.md index 01a4741..420dd96 100644 --- a/README.md +++ b/README.md @@ -151,7 +151,7 @@ breast_default #> → BaseRunDigest: ``` -Finally, we will load the base run for the Breast model +Finally, we will load the base run for the Breast model. ``` r baserun_digest <- breast$run_list$RunDigest[[1]] @@ -173,7 +173,7 @@ create_scenario('OncoSimX-breast', 'MyNewScenario', baserun_digest) ``` We will load the new scenario, copy over the `ProvincesOfInterest` -parameter from the base run and extract it to a CSV file for editing +parameter from the base run and extract it to a CSV file for editing. ``` r new_scenario <- load_scenario('OncoSimX-breast', 'MyNewScenario') @@ -191,7 +191,7 @@ time. new_scenario$run('ExampleRun', wait = TRUE) ``` -Now that our model run is complete, lets load it into memory +Now that our model run is complete, lets load it into memory. ``` r example_run <- load_run('OncoSimX-breast', 'ExampleRun') @@ -225,7 +225,7 @@ example_run$get_table('Breast_Cancer_Cases_Table') #> # ℹ 8,167 more rows ``` -Great, we have create a new scenario, extracted some parameters to +Great, we have created a new scenario, extracted some parameters to potentially modify, ran the model, and extracted output tables. In this last step, we will load multiple model runs into memory to compare them.