rerender of updated vignettes

matthewphamilton · matthewphamilton · commit 74eca4e9eab3 · 2024-06-13T15:49:40.000+10:00
diff --git a/content/en/docs/Getting-started/Implementation/Paradigm/Object-Oriented/index.en.md b/content/en/docs/Getting-started/Implementation/Paradigm/Object-Oriented/index.en.md
@@ -1,7 +1,7 @@
 ---
 title: "Why ready4 is object oriented"
 linkTitle: "Paradigm"
-date: "2024-06-11"
+date: "2024-06-13"
 description: "ready4 uses an object oriented programming (OOP) paradigm to implement computational models."
 weight: 61
 aliases:
diff --git a/content/en/docs/Software/Libraries/Installation/Authoring-Tools/Code-Development/index.en.md b/content/en/docs/Software/Libraries/Installation/Authoring-Tools/Code-Development/index.en.md
@@ -2,7 +2,7 @@
 title: Installing tools for authoring computational models
 linkTitle: "Models"
 author: Matthew Hamilton
-date: "2024-06-11"
+date: "2024-06-13"
 description: Instructions for installing the ready4class, ready4fun and ready4pack libraries.
 weight: 1
 categories: 
diff --git a/content/en/docs/Software/Libraries/Installation/Authoring-Tools/Datasets/index.en.md b/content/en/docs/Software/Libraries/Installation/Authoring-Tools/Datasets/index.en.md
@@ -2,7 +2,7 @@
 title: Installing tools for authoring and managing model datasets
 linkTitle: "Datasets"
 author: Matthew Hamilton
-date: "2024-06-11"
+date: "2024-06-13"
 description: Instructions for installing the ready4use library.
 weight: 2
 categories: 
diff --git a/content/en/docs/Software/Libraries/Installation/Authoring-Tools/Reporting/index.en.md b/content/en/docs/Software/Libraries/Installation/Authoring-Tools/Reporting/index.en.md
@@ -2,7 +2,7 @@
 title: Installing tools for authoring reproducible analyses
 linkTitle: "Analyses"
 author: Matthew Hamilton
-date: "2024-06-11"
+date: "2024-06-13"
 description: Instructions for installing the ready4show library.
 weight: 3
 categories: 
diff --git a/content/en/docs/Software/Libraries/Installation/Foundation/index.en.md b/content/en/docs/Software/Libraries/Installation/Foundation/index.en.md
@@ -2,7 +2,7 @@
 title: Installing the ready4 framework foundation library
 linkTitle: "Foundation"
 author: Matthew Hamilton
-date: "2024-06-11"
+date: "2024-06-13"
 description: The ready4 framework foundation is the first ready4 library you should install.
 slug: Foundation
 weight: 1
diff --git a/content/en/docs/Software/Libraries/Installation/Modules/index.en.md b/content/en/docs/Software/Libraries/Installation/Modules/index.en.md
@@ -2,7 +2,7 @@
 title: Installing ready4 computational model modules
 linkTitle: "Modules"
 author: Matthew Hamilton
-date: "2024-06-11"
+date: "2024-06-13"
 description: To implement a modelling analysis with ready4 you need to install computational model modules.
 slug: Modules
 weight: 3
diff --git a/content/en/docs/Tutorials/Develop-Models/Authoring-Modules/Authoring-Algorithms/index.en.md b/content/en/docs/Tutorials/Develop-Models/Authoring-Modules/Authoring-Algorithms/index.en.md
@@ -1,7 +1,7 @@
 ---
 title: "Authoring model algorithms"
 linkTitle: "Algorithms"
-date: "2024-06-11"
+date: "2024-06-13"
 description: "The ready4fun R package supports standardised approaches to code authoring that facilitate partial automation of the documenting of model algorithms."
 weight: 64
 aliases:
@@ -610,8 +610,7 @@ Further information about the purpose of a function and the nature of its inputs
 
 <pre class='chroma'><code class='language-r' data-lang='r'><span><span class='nv'>z</span> <span class='o'>&lt;-</span> <span class='nf'><a href='https://ready4-dev.github.io/ready4fun/reference/get_abbrs.html'>get_abbrs</a></span><span class='o'>(</span>gh_repo_1L_chr <span class='o'>=</span> <span class='s'>"ready4-dev/ready4"</span><span class='o'>)</span></span>
 <span><span class='nf'><a href='https://rdrr.io/r/base/class.html'>class</a></span><span class='o'>(</span><span class='nv'>z</span><span class='o'>)</span></span>
-<span><span class='c'>#&gt; [1] "ready4fun_abbreviations" "tbl_df"                  "tbl"                    </span></span>
-<span><span class='c'>#&gt; [4] "data.frame"</span></span>
+<span><span class='c'>#&gt; [1] "ready4fun_abbreviations" "tbl_df"                  "tbl"                     "data.frame"</span></span>
 <span></span></code></pre>
 
 </div>
diff --git a/content/en/docs/Tutorials/Develop-Models/Authoring-Modules/Authoring-Classes/index.en.md b/content/en/docs/Tutorials/Develop-Models/Authoring-Modules/Authoring-Classes/index.en.md
@@ -1,7 +1,7 @@
 ---
 title: "Authoring model data structures"
 linkTitle: "Data structures"
-date: "2024-06-11"
+date: "2024-06-13"
 description: "The ready4class R package supports partially automated and standardised workflows for defining the data structures to be used in computational models."
 weight: 62
 aliases:
diff --git a/content/en/docs/Tutorials/Develop-Models/Authoring-Modules/Authoring-Libraries/index.en.md b/content/en/docs/Tutorials/Develop-Models/Authoring-Modules/Authoring-Libraries/index.en.md
@@ -1,7 +1,7 @@
 ---
 title: "Dissemating citable, documented and quality assured model module libraries"
 linkTitle: "Libraries"
-date: "2024-06-11"
+date: "2024-06-13"
 description: "ready4 supports tools to streamline the testing, description and distribution of computational model modules."
 weight: 66
 aliases:
diff --git a/content/en/docs/Tutorials/Develop-Models/Maintenance/index.en.md b/content/en/docs/Tutorials/Develop-Models/Maintenance/index.en.md
@@ -1,7 +1,7 @@
 ---
 title: "Partially automate maintenance of a modelling project's website"
 linkTitle: "Maintenance"
-date: "2024-06-11"
+date: "2024-06-13"
 description: "ready4 includes tools that can help maintain the documentation website for a modelling project."
 weight: 4
 categories: 
@@ -59,9 +59,9 @@ The `write_to_render_post` is the main `ready4` function used specifically for w
 
 -   `make_datasets_tb` and `print_data` for updating details on module datasets (see [this example](https://readyforwhatsnext.org/docs/tutorials/finding/finding-data/))
 
--   `get_datasets_tb`, `make_dss_tb` and `make_ds_releases_tbl` for updating release statuses of module datasets (see this [RMD file](https://github.com/ready4-dev/readyforwhatsnext/blob/main/content/en/blog/releases/Datasets/Model-Data/People-Datasets/index_Body.Rmd) and its [output](https://readyforwhatsnext.org/blog/2024/01/25/datasets-for-modelling-people-releases/))
+-   `get_datasets_tb`, `make_dss_tb` and `make_ds_releases_tbl` for updating release statuses of module datasets (see this [RMD file](https://github.com/ready4-dev/readyforwhatsnext/blob/main/content/en/blog/releases/Datasets/Model-Data/People-Datasets/index_Body.Rmd) and its [output](https://readyforwhatsnext.org/blog/2024/06/08/datasets-for-modelling-people-releases/))
 
 -   `make_programs_tbl` for updating details on analysis programs or reporting sub-routines that use model modules (see [this RMD file](https://github.com/ready4-dev/readyforwhatsnext/blob/main/content/en/docs/Analyses/Find/index_Body.Rmd) and [its associated output](https://readyforwhatsnext.org/docs/analyses/find/#current-readyforhwatsnext-programs) as well as this [RMD file](https://github.com/ready4-dev/readyforwhatsnext/blob/main/content/en/docs/Reporting/index_Body.Rmd) and [its output](https://readyforwhatsnext.org/docs/reporting/#current-readyforwhatsnext-subroutines))
 
--   `make_code_releases_tbl` for updating release statuses of module libraries and programs or reporting sub-routines that use model modules (see this [RMD file](https://github.com/ready4-dev/readyforwhatsnext/blob/main/content/en/blog/releases/Executables/Programs/index_Body.Rmd) and its [output](https://readyforwhatsnext.org/blog/2024/01/25/programs-releases/))
+-   `make_code_releases_tbl` for updating release statuses of module libraries and programs or reporting sub-routines that use model modules (see this [RMD file](https://github.com/ready4-dev/readyforwhatsnext/blob/main/content/en/blog/releases/Executables/Programs/index_Body.Rmd) and its [output](https://readyforwhatsnext.org/blog/2024/06/08/programs-releases/))
 
diff --git a/content/en/docs/Tutorials/Develop-Models/Modularity/index.en.md b/content/en/docs/Tutorials/Develop-Models/Modularity/index.en.md
@@ -1,7 +1,7 @@
 ---
 title: "Template module"
 linkTitle: "Template"
-date: "2024-06-11"
+date: "2024-06-13"
 description: "ready4 provides a template to facilitate modular implementation of health economic models."
 weight: 1
 aliases:
@@ -48,7 +48,7 @@ A potentially attractive approach to modelling complex health systems is to begi
 
 ## Implementation
 
-The `ready4` package provides foundational elements of a [prototype software framework](https://www.ready4-dev.com/) to support the development of modular and open-source computational health economic models using R. Modular model development is enabled by the [encapsulation and inheritance features of Object Oriented Programming (OOP)](https://www.ready4-dev.com/docs/framework/implementation/paradigm/object-oriented/). Specifically, `ready4` uses two of R's systems for implementing OOP - S3 and S4. An in-depth explanation of R's different class system is beyond the scope of this article, but is explored in [Hadley Wickham's Advanced R handbook](https://adv-r.hadley.nz/oo.html). However, it is useful to know some very high level information about S3 and S4 classes:
+The `ready4` facilitates modular model development by supplying a template module that enables model developers to avail of the [encapsulation and inheritance features of Object Oriented Programming (OOP)](https://www.ready4-dev.com/docs/framework/implementation/paradigm/object-oriented/). The [ready4 framework](https://www.ready4-dev.com/) uses two of R's systems for implementing OOP - S3 and S4. An in-depth explanation of R's different class system is beyond the scope of this article, but is explored in [Hadley Wickham's Advanced R handbook](https://adv-r.hadley.nz/oo.html). However, it is useful to know some very high level information about S3 and S4 classes:
 
 -   S4 classes are frequently said to be "formal", "strict" or "rigorous". The elements of an S4 class are called slots and the type of data that each slot is allowed to contain is specified in the class definition. An S4 class can be comprised of slots that contain different types of data (e.g. a slot that contains a character vector and another slot that contains tabular data).
 
@@ -79,7 +79,7 @@ However, if we inspect `X` we can see it is of limited use as it contains no dat
 
 </div>
 
-The `Ready4Module` class is therefore not intended to be called directly. Instead, the purpose of `Ready4Module` is to be the parent class of other model modules. Prototype tools for authoring modules from this template are described [here](https://www.ready4-dev.com/docs/tutorials/authoring-modules/).
+The `Ready4Module` class is therefore not intended to be called directly. Instead, the purpose of `Ready4Module` is to be the parent class of other model modules. Prototype tools for authoring modules from this template are described [here](https://www.ready4-dev.com/docs/tutorials/develop-models/authoring-modules/).
 
 <div class="card border-primary mb-3" style="max-width: 20rem;">
 
diff --git a/content/en/docs/Tutorials/Develop-Models/Syntax/index.en.md b/content/en/docs/Tutorials/Develop-Models/Syntax/index.en.md
@@ -1,7 +1,7 @@
 ---
 title: "Provide end users with a simple and consistent syntax for using model modules"
 linkTitle: "Syntax"
-date: "2024-06-11"
+date: "2024-06-13"
 description: "Methods are associated with ready4 modules using a novel syntax."
 weight: 2
 aliases:
@@ -50,19 +50,17 @@ Transparency is one of the underpinning principles of ethical modelling practice
 
 ## Use
 
-`ready4` includes a number of core generic functions which describe the main types of method to be implemented by model modules. These generics correspond exactly to the "core", "slot" and "extended" commands described in [another article](https://ready4-dev.github.io/ready4/articles/V_02.html).
+`ready4` includes a number of core generic functions which describe the main types of method to be implemented by model modules. These generics correspond exactly to the "core", "slot" and "extended" commands described in [another article](https://www.ready4-dev.com/docs/tutorials/use-models/authoring-analyses/commands/).
 
-Notably, the `ready4` package does not associate any core or extended methods with the `Ready4Module` [template module](https://www.ready4-dev.com/docs/getting-started/implementation/modularity/). Instead, model developers need to decide which core and extended generics they associate with the modules they derive from the `Ready4Module` template. This decision is typically made when authoring the methods associated with model modules.
+Notably, the `ready4` package does not associate any core or extended methods with the `Ready4Module` [template module](https://www.ready4-dev.com/docs/framework/implementation/modularity/). Instead, model developers need to decide which core and extended generics they associate with the modules they derive from the `Ready4Module` template. This decision is typically made when authoring the methods associated with model modules.
 
-Currently, the only methods defined for `Ready4Module` are [slot-methods](https://www.ready4-dev.com/docs/framework/implementation/syntax/#slot-generics-and-methods). By default, these slot methods are inherited by all modules derived from the `Ready4Module` template. These methods can be itemised using the `get_methods` function.
+Currently, the only methods defined for `Ready4Module` are [slot-methods](https://www.ready4-dev.com/docs/tutorials/use-models/authoring-analyses/commands/). By default, these slot methods are inherited by all modules derived from the `Ready4Module` template. These methods can be itemised using the `get_methods` function.
 
 <div class="highlight">
 
 <pre class='chroma'><code class='language-r' data-lang='r'><span><span class='nf'><a href='https://ready4-dev.github.io/ready4/reference/get_methods.html'>get_methods</a></span><span class='o'>(</span><span class='o'>)</span></span>
-<span><span class='c'>#&gt;  [1] "authorSlot"        "characterizeSlot"  "depictSlot"        "enhanceSlot"      </span></span>
-<span><span class='c'>#&gt;  [5] "exhibitSlot"       "ingestSlot"        "investigateSlot"   "manufactureSlot"  </span></span>
-<span><span class='c'>#&gt;  [9] "metamorphoseSlot"  "procureSlot"       "prognosticateSlot" "ratifySlot"       </span></span>
-<span><span class='c'>#&gt; [13] "reckonSlot"        "renewSlot"         "shareSlot"</span></span>
+<span><span class='c'>#&gt;  [1] "authorSlot"        "characterizeSlot"  "depictSlot"        "enhanceSlot"       "exhibitSlot"       "ingestSlot"        "investigateSlot"   "manufactureSlot"  </span></span>
+<span><span class='c'>#&gt;  [9] "metamorphoseSlot"  "procureSlot"       "prognosticateSlot" "ratifySlot"        "reckonSlot"        "renewSlot"         "shareSlot"</span></span>
 <span></span></code></pre>
 
 </div>
diff --git a/content/en/docs/Tutorials/Use-Models/Finding-Modules/Collections/index.en.md b/content/en/docs/Tutorials/Use-Models/Finding-Modules/Collections/index.en.md
@@ -1,7 +1,7 @@
 ---
 title: "Find themed collections of ready4 modules"
 linkTitle: "Collections"
-date: "2024-06-11"
+date: "2024-06-13"
 description: "Tools from the ready4 R library can help find details about module libraries from a modelling project."
 weight: 91
 tags:
@@ -386,5 +386,5 @@ Develop, Use and Share Unit Cost Datasets for Health Economic
 
 ## Related content
 
-Details of how to search for details on individual modules is described in [another article](https://ready4-dev.github.io/ready4/articles/V_05.html).
+Details of how to search for details on individual modules is described in [another article](https://www.ready4-dev.com/docs/tutorials/use-models/finding-modules/modules/).
 
diff --git a/content/en/docs/Tutorials/Use-Models/Finding-Modules/Modules/index.en.md b/content/en/docs/Tutorials/Use-Models/Finding-Modules/Modules/index.en.md
@@ -1,7 +1,7 @@
 ---
 title: "Find examples of how model modules are used"
 linkTitle: "Examples"
-date: "2024-06-11"
+date: "2024-06-13"
 description: "Tools from the ready4 R library can help find details about the use of individual model modules."
 weight: 92
 tags:
@@ -386,5 +386,5 @@ Develop, Use and Share Unit Cost Datasets for Health Economic
 
 ## Related content
 
-Details of how to search for details on individual modules is described in [another article](https://ready4-dev.github.io/ready4/articles/V_05.html).
+Details of how to search for details on individual modules is described in [another article](https://www.ready4-dev.com/docs/tutorials/use-models/finding-modules/modules/).
 
