Skip to content

Commit bb34fc0

Browse files
matthewphamiltonmatthewphamilton
committed
regenerated vignettes
1 parent c52e70a commit bb34fc0

File tree

32 files changed

+858
-2150
lines changed

32 files changed

+858
-2150
lines changed

‎content/en/blog/releases/Datasets/Framework-Taxonomies/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Framework taxonomies dataset releases"
33
linkTitle: "Taxonomies"
4-
date: "2024-06-08"
4+
date: "2024-06-11"
55
description: "Releases of the dataset of taxonomies used to help standardise code authoring and documentation."
66
weight: 2
77
categories:

‎content/en/blog/releases/Libraries/Framework-Libraries/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Framework library releases"
33
linkTitle: "Framework libraries"
4-
date: "2024-06-08"
4+
date: "2024-06-11"
55
description: "Releases of foundation and authoring tools libraries to implement the ready4 framework."
66
weight: 1
77
categories:
@@ -17,7 +17,7 @@ rmd_hash: fb3125ee4f3218b5
1717

1818
---
1919

20-
Currently available (as at 08-Jun-2024) releases of [framework libraries](/docs/software/libraries/types/framework/) are described below.
20+
Currently available (as at 11-Jun-2024) releases of [framework libraries](/docs/software/libraries/types/framework/) are described below.
2121

2222
<html>
2323

‎content/en/docs/Getting-started/Implementation/Paradigm/Functional/_index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ Although the [object-oriented programming (OOP)](/docs/framework/implementation/
2828
2929
In practical terms, this means that if not carefully planned, using OOP can create barriers to code-reuse as algorithms come bundled with artefacts of no/low relevance to many potential users. To help maximise the accessibility and re-usability of ready4 algorithms, these algorithms are primarily written using the functional programming paradigm. Only once an algorithm has been implemented using functions are they then linked to a data-structure by means of a calling method. The typical development workflow for a ready4 computational [modelling project](/docs/getting-started/concepts/project/) might therefore look something the following three step process:
3030

31-
1. A modelling study algorithm is implemented as a [program](/docs/software/executables/programs/).
31+
1. A modelling study algorithm is initially implemented as a program.
3232

33-
2. To help [transfer](/docs/getting-started/concepts/transferable/) the methods used in the study algorithm, it is decomposed into functions, which are bundled as a [code library](/docs/software/libraries/) (or libraries). The program is updated to use the newly authored functions.
33+
2. To help [transfer](/docs/getting-started/concepts/transferable/) the methods used in the study algorithm, it is decomposed into functions, which are bundled as a code library (or libraries). The program is updated to use the newly authored functions.
3434

35-
3. A [ready4 module](/docs/framework/implementation/modularity/) is authored to define a data-structure along with a method (or methods) that call the functions to implement the transferable version of the study algorithm. The new module is added to the previously created code library and the program is again updated so that the algorithm is now implemented by supplying data to the ready4 module and then calling the desired method(s).
35+
3. A model module is authored from a [template](/docs/framework/implementation/modularity/) to define a data-structure. A method (or methods) that call the functions authored in the previous step is attached to the module(s) using the ready4 framework's [syntax](/docs/tutorials/develop-models/syntax/). The new module is added to the previously created code library and the program is again updated so that the algorithm is now implemented by supplying data to the ready4 module and then calling the desired method(s).
3636

37-
[Modellers](/docs/getting-started/users/modeller/) using ready4 for the most part will only use ready4 modules and will rarely interact directly with the functions that implement module methods. However, these functions are potentially of significant usefulness to [coders](/docs/getting-started/users/coder/) authoring new algorithms. A helpful way of exploring currently available functions is to use the [ready4 dependencies app](/docs/software/libraries/dependencies/). All ready4 [functions are created with minimal, but consistent documentation](/docs/framework/use/authoring-modules/authoring-algorithms/) with the aid of tools from the [ready4fun](https://ready4-dev.github.io/ready4fun/) library.
37+
[Modellers](/docs/getting-started/users/modeller/) using ready4 for the most part will only use ready4 modules and will rarely interact directly with the functions that implement module methods. However, these functions are potentially of significant usefulness to [coders](/docs/getting-started/users/coder/) authoring new algorithms. All ready4 [functions are created with minimal, but consistent documentation](/docs/framework/use/authoring-modules/authoring-algorithms/) with the aid of tools from the [ready4fun](https://ready4-dev.github.io/ready4fun/) library.

‎content/en/docs/Getting-started/Implementation/Paradigm/Object-Oriented/index.en.Rmarkdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This below section renders a vignette article from the ready4 library. You can u
3737
#setInternet2(use = TRUE)
3838
x <- tempfile(fileext = "Rmd")
3939
on.exit(unlink(x))
40-
download.file("https://raw.githubusercontent.com/ready4-dev/ready4/master/vignettes/V_03.Rmd", x)
40+
download.file("https://raw.githubusercontent.com/ready4-dev/ready4/main/vignettes/V_03.Rmd", x)
4141
```
4242

4343
```{r test-main, child=x}

‎content/en/docs/Getting-started/Implementation/Paradigm/Object-Oriented/index.en.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Why ready4 is object oriented"
33
linkTitle: "Paradigm"
4-
date: "2024-06-08"
4+
date: "2024-06-11"
55
description: "ready4 uses an object oriented programming (OOP) paradigm to implement computational models."
66
weight: 61
77
aliases:
@@ -21,7 +21,7 @@ tags:
2121
- Status
2222
- Status - development
2323
output: hugodown::md_document
24-
rmd_hash: ea7ab544f15ec64a
24+
rmd_hash: deb669294fd828ae
2525

2626
---
2727

‎content/en/docs/Model/Modules/Using-Modules/People/Add-Metadata/index.en.Rmarkdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ This below section renders a vignette article from the youthvars library. You ca
3232
# x <- "UntitledRMD.Rmd"
3333
x <- tempfile(fileext = "Rmd")
3434
on.exit(unlink(x))
35-
download.file("https://raw.githubusercontent.com/ready4-dev/youthvars/master/vignettes/V_02.Rmd", x)
35+
download.file("https://raw.githubusercontent.com/ready4-dev/youthvars/main/vignettes/V_02.Rmd", x)
3636
```
3737

3838
```{r test-main, child=x}

‎content/en/docs/Software/Libraries/Installation/Authoring-Tools/Code-Development/index.en.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Installing tools for authoring computational models
33
linkTitle: "Models"
44
author: Matthew Hamilton
5-
date: "2024-06-08"
5+
date: "2024-06-11"
66
description: Instructions for installing the ready4class, ready4fun and ready4pack libraries.
77
weight: 1
88
categories:

‎content/en/docs/Software/Libraries/Installation/Authoring-Tools/Datasets/index.en.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Installing tools for authoring and managing model datasets
33
linkTitle: "Datasets"
44
author: Matthew Hamilton
5-
date: "2024-06-08"
5+
date: "2024-06-11"
66
description: Instructions for installing the ready4use library.
77
weight: 2
88
categories:

‎content/en/docs/Software/Libraries/Installation/Authoring-Tools/Reporting/index.en.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Installing tools for authoring reproducible analyses
33
linkTitle: "Analyses"
44
author: Matthew Hamilton
5-
date: "2024-06-08"
5+
date: "2024-06-11"
66
description: Instructions for installing the ready4show library.
77
weight: 3
88
categories:

‎content/en/docs/Software/Libraries/Installation/Foundation/index.en.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Installing the ready4 framework foundation library
33
linkTitle: "Foundation"
44
author: Matthew Hamilton
5-
date: "2024-06-08"
5+
date: "2024-06-11"
66
description: The ready4 framework foundation is the first ready4 library you should install.
77
slug: Foundation
88
weight: 1

0 commit comments

Comments
 (0)