text edits to clarify relationship with ready4 model

ready4-dev · Oct 3, 2023 · 81392fd · 81392fd
1 parent 43c25d4
commit 81392fd
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/vignettes/V_01.Rmd b/vignettes/V_01.Rmd
@@ -21,10 +21,10 @@ library(youthvars)
 ```
 
 ## Variable classes and data integrity
-The `youthvars` package defines a number of [ready4 framework sub-module classes](https://www.ready4-dev.com/docs/framework/implementation/modularity/#ready4-model-sub-modules) that can be used to quality assure input or output datasets for the [ready4 economic model of youth mental health](https://www.ready4-dev.com/). `youthvars` sub-modules are potentially useful for:
+The `youthvars` package includes a number of [ready4 framework sub-module classes](https://www.ready4-dev.com/docs/framework/implementation/modularity/#ready4-model-sub-modules) that form part of the [ready4 economic model of youth mental health](https://www.ready4-dev.com/docs/model/). The primary use of `youthvars` sub-modules is to quality assure the variables used in model input and output datasets by:
 
 1) facilitating automated data integrity checks that verify no impermissible values (e.g. utility scores greater than one) are present in source data, transformed data or results; and
-2) automating the selection of the appropriate method to apply to each data type.
+2) implementing rules-based automated selection and application of appropriate methods for each dataset variable.
 
 ## Included sub-module classes
 

diff --git a/vignettes/V_02.Rmd b/vignettes/V_02.Rmd
@@ -23,7 +23,7 @@ library(ready4)
 library(youthvars)
 ```
 
-Youthvars provides two [ready4 modules](https://www.ready4-dev.com/docs/framework/implementation/modularity/#ready4-model-modules) - `YouthvarsProfile` and `YouthvarsSeries` to help describe key features of youth mental health datasets. The ready4 modules in `youthvars` extend the [Ready4useDyad module](https://www.ready4-dev.com/docs/framework/use/authoring-data/label-data/) .
+Youthvars provides two [ready4 framework modules](https://www.ready4-dev.com/docs/framework/implementation/modularity/#ready4-model-modules) - `YouthvarsProfile` and `YouthvarsSeries` that form part of the [ready4 economic model of youth mental health](https://www.ready4-dev.com/docs/model/). The ready4 modules in `youthvars` extend the [Ready4useDyad module](https://www.ready4-dev.com/docs/framework/use/authoring-data/label-data/) and can be used to help describe key structural properties of youth mental health datasets.
 
 ## Ingest data
 To start we ingest  `X`, a `Ready4useDyad` (dataset and data dictionary pair) that we can download from a remote repository.

diff --git a/vignettes/youthvars.Rmd b/vignettes/youthvars.Rmd
@@ -17,7 +17,7 @@ knitr::opts_chunk$set(
 ```{r setup}
 library(youthvars)
 ```
-The [modules and sub-modules](https://www.ready4-dev.com/docs/framework/implementation/modularity/) in youthvars are designed to make it easier to use youth mental health human record data (including synthetic data) in the [ready4 economic model of youth mental health](https://www.ready4-dev.com/).
+The [modules and sub-modules](https://www.ready4-dev.com/docs/framework/implementation/modularity/) in youthvars are designed to make it easier to use youth mental health human record data (including synthetic data) in the [ready4 health economic model](https://www.ready4-dev.com/docs/model/).
 
 The following vignettes demonstrate some of the modules and sub-modules currently included in the youthvars package: