Skip to content

Commit ecd84cb

Browse files
rebuilt all vignettes
1 parent 3a6a5cd commit ecd84cb

6 files changed

Lines changed: 47 additions & 42 deletions

File tree

vignettes/CSP_AQOL6D_TTU.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "AQoL-6D Clinical Population Example (Deprecated)"
2+
title: "(Defunct) AQoL-6D Clinical Population Example"
33
output: rmarkdown::html_vignette
44
vignette: >
5-
%\VignetteIndexEntry{AQoL-6D Clinical Population Example (Deprecated)}
5+
%\VignetteIndexEntry{(Defunct) AQoL-6D Clinical Population Example}
66
%\VignetteEngine{knitr::rmarkdown}
77
%\VignetteEncoding{UTF-8}
88
---

vignettes/CSP_EQ5D_TTU.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "EQ5D General Population Example (Deprecated)"
2+
title: "(Defunct) EQ5D General Population Example"
33
output: rmarkdown::html_vignette
44
vignette: >
5-
%\VignetteIndexEntry{EQ5D General Population Example (Deprecated)}
5+
%\VignetteIndexEntry{(Defunct) EQ5D General Population Example}
66
%\VignetteEngine{knitr::rmarkdown}
77
%\VignetteEncoding{UTF-8}
88
---

vignettes/Model_TTU.Rmd

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
---
2-
title: "Exploratory Analysis Workflow"
3-
output: rmarkdown::html_vignette
4-
vignette: >
5-
%\VignetteIndexEntry{Exploratory Analysis Workflow}
6-
%\VignetteEngine{knitr::rmarkdown}
7-
%\VignetteEncoding{UTF-8}
8-
---
9-
10-
**The workflow previously described on this page is now defunct as the functions it relied on have been superseded by methods in the [specific package](https://ready4-dev.github.io/specific). Updated syntax for reporting utility mapping studies with the TTU package is currently being developed.**
11-
1+
---
2+
title: "(Defunct) Exploratory Analysis Workflow"
3+
output: rmarkdown::html_vignette
4+
vignette: >
5+
%\VignetteIndexEntry{(Defunct) Exploratory Analysis Workflow}
6+
%\VignetteEngine{knitr::rmarkdown}
7+
%\VignetteEncoding{UTF-8}
8+
---
9+
10+
**The workflow previously described on this page is now defunct as the functions it relied on have been superseded by methods in the [specific package](https://ready4-dev.github.io/specific).**
11+

vignettes/TTU.Rmd

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
---
2-
title: "TTU"
3-
output: rmarkdown::html_vignette
4-
vignette: >
5-
%\VignetteIndexEntry{TTU}
6-
%\VignetteEngine{knitr::rmarkdown}
7-
%\VignetteEncoding{UTF-8}
8-
---
9-
10-
```{r, include = FALSE}
11-
knitr::opts_chunk$set(
12-
collapse = TRUE,
13-
comment = "#>"
14-
)
15-
```
16-
17-
```{r setup}
18-
library(TTU)
19-
```
20-
21-
**The TTU package is currently undergoing significant redevelopment. Many of the functions previously included in the package have been replaced by methods in the [specific package](https://ready4-dev.github.io/specific). More information will be poster here shortly.**
22-
23-
This development version of the TTU package has been made available as part of the process of testing and documenting the package. [Installation instructions are on the package homepage](https://ready4-dev.github.io/TTU/index.html).
24-
25-
26-
1+
---
2+
title: "TTU"
3+
output: rmarkdown::html_vignette
4+
vignette: >
5+
%\VignetteIndexEntry{TTU}
6+
%\VignetteEngine{knitr::rmarkdown}
7+
%\VignetteEncoding{UTF-8}
8+
---
9+
10+
```{r, include = FALSE}
11+
knitr::opts_chunk$set(
12+
collapse = TRUE,
13+
comment = "#>"
14+
)
15+
```
16+
17+
```{r setup, message=FALSE, warning=FALSE, results='hide'}
18+
library(TTU)
19+
```
20+
21+
This development version of the TTU package has been made available as part of the process of testing and documenting the package. [Installation instructions are on the package homepage](https://ready4-dev.github.io/TTU/index.html). Currently, one vignette article is available to demonstrate how to use the TTU package:
22+
23+
- [Implement A Utility Mapping Study (Adolescent AQoL-6D Example)](V_01.html)
24+
25+
26+

vignettes/V_01.Rmd

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Additionally, TTU relies on two RMarkdown programs:
3333
### Background and citation
3434
The following workflow illustrates (**using fake data**) the same steps we used in a real world study, a summary of which is available at https://doi.org/10.1101/2021.07.07.21260129). Citation information for that study is:
3535

36+
```{r eval=F}
3637
@article {Hamilton2021.07.07.21260129,
3738
author = {Hamilton, Matthew P and Gao, Caroline X and Filia, Kate M and Menssink, Jana M and Sharmin, Sonia and Telford, Nic and Herrman, Helen and Hickie, Ian B and Mihalopoulos, Cathrine and Rickwood, Debra J and McGorry, Patrick D and Cotton, Sue M},
3839
title = {Predicting Quality Adjusted Life Years in young people attending primary mental health services},
@@ -44,9 +45,11 @@ The following workflow illustrates (**using fake data**) the same steps we used
4445
eprint = {https://www.medrxiv.org/content/early/2021/07/12/2021.07.07.21260129.full.pdf},
4546
journal = {medRxiv}
4647
}
48+
```
4749

4850
The program applied in that study, which this workflow closely resembles is available at https://doi.org/10.5281/zenodo.6116077 and can be cited as follows:
4951

52+
```{r eval=FALSE}
5053
@software{hamilton_matthew_2022_6212704,
5154
author = {Hamilton, Matthew and
5255
Gao, Caroline},
@@ -68,6 +71,8 @@ The program applied in that study, which this workflow closely resembles is avai
6871
doi = {10.5281/zenodo.6212704},
6972
url = {https://doi.org/10.5281/zenodo.6212704}
7073
}
74+
```
75+
7176

7277
### Load required packages
7378
We begin by loading our required packages.
@@ -175,7 +180,7 @@ A <- renewSlot(A, "c_SpecificProject",
175180
authorSlot(A, "c_SpecificProject", what_1L_chr = "workspace"))
176181
```
177182

178-
We now generate tables and charts that describe our dataset. These are saved in a sub-directory of our output data directory, a copy of which is [available for download](https://github.com/ready4-dev/TTU/releases/download/Documentation_0.0/_A_Candidate_Mdls_Cmprsn_Descriptives.zip). One of the plots is also reproduced here.
183+
We now generate tables and charts that describe our dataset. These are saved in a sub-directory of our output data directory, a copy of which is [available for download](https://github.com/ready4-dev/TTU/releases/download/Documentation_0.0/_Descriptives.zip). One of the plots is also reproduced here.
179184

180185
```{r message=FALSE, results='hide', warning=FALSE}
181186
A <- renewSlot(A, "c_SpecificProject",

vignettes/aaaaaaaaaa.txt

Whitespace-only changes.

0 commit comments

Comments
 (0)