Skip to content

Commit

Permalink
text edits to vignettes
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewphamilton committed Dec 22, 2022
1 parent a511dac commit 9bba456
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 35 deletions.
4 changes: 2 additions & 2 deletions data-raw/DATASET.R
Original file line number Diff line number Diff line change
Expand Up @@ -183,5 +183,5 @@ readLines(".github/workflows/R-CMD-check.yaml") %>%
stringr::str_replace_all("r-lib/actions/setup-r@master","r-lib/actions/setup-r@v2") %>%
stringr::str_replace_all("r-lib/actions/setup-pandoc@master","r-lib/actions/setup-pandoc@v2") %>%
writeLines(con = ".github/workflows/R-CMD-check.yaml")
writeLines(c("main table {"," display: table;","}"),
con = "pkgdown/extra.css")
# writeLines(c("main table {"," display: table;","}"),
# con = "pkgdown/extra.css")
6 changes: 3 additions & 3 deletions vignettes/V_01.Rmd
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Disseminate Ready4 Framework Datasets"
title: "Disseminate Ready4 Datasets"
output:
rmarkdown::html_vignette:
toc: true
pdf_document:
highlight: null
number_sections: yes
vignette: >
%\VignetteIndexEntry{Disseminate Ready4 Framework Datasets}
%\VignetteIndexEntry{Disseminate Ready4 Datasets}
%\VignetteEncoding{UTF-8}
%\VignetteEngine{knitr::rmarkdown}
---
Expand All @@ -23,7 +23,7 @@ library(ready4)
library(ready4use)
```

ready4use includes a number of tools for sharing data used in conjunction with the ready4 open source model of youth mental health systems.
ready4use includes a number of tools for sharing data used in conjunction with the [ready4 open source model of youth mental health systems](https://www.ready4-dev.com].

## Identify data to be shared
To illustrate how to share data using `ready4use` classes and methods, we will first need some data to publish. In this example, we are going to share `X`, a `Ready4useDyad` [(a data structure explained in another vignette)](https://ready4-dev.github.io/ready4use/V_02.html) that we can create using [data ingested from an online repository](https://ready4-dev.github.io/ready4use/V_03.html).
Expand Down
6 changes: 4 additions & 2 deletions vignettes/V_02.Rmd
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Pair a Ready4 Framework Dataset and Its Dictionary
title: Pair a Ready4 Dataset and Its Dictionary
output:
rmarkdown::html_vignette:
toc: true
pdf_document:
highlight: null
number_sections: yes
vignette: >
%\VignetteIndexEntry{Pair a Ready4 Framework Dataset and Its Dictionary}
%\VignetteIndexEntry{Pair a Ready4 Dataset and Its Dictionary}
%\VignetteEncoding{UTF-8}
%\VignetteEngine{knitr::rmarkdown}
---
Expand All @@ -23,6 +23,8 @@ library(ready4)
library(ready4use)
```

ready4use includes a number of tools for labeling data used in conjunction with the [ready4 open source model of youth mental health systems](https://www.ready4-dev.com].

## Create a dataset-dictionary pair
A data dictionary containts useful metadata about a dataset. We can ingest examples of a fake dataset and its data-dictionary [using the method explained in another vignette](V_01.html).

Expand Down
3 changes: 2 additions & 1 deletion vignettes/V_03.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ We recommend also reading the related tutorial available at: https://www.acumen-
library(ready4)
library(ready4use)
```
Ready4use includes a number of tools for ingesting data for use in conjunction with the ready4 model.

ready4use includes a number of tools for ingesting data from online repositories used in conjunction with the [ready4 open source model of youth mental health systems](https://www.ready4-dev.com].

## Specify remote repositories
The `Ready4useRepos` class can be used to specify details of the data repositories used in your data management workflows. Currently, the two types of repository that can be specified in a `Ready4useRepos` class are Dataverse datasets and GitHub releases. `Ready4useRepos` methods for download / upload extend tools from the `dataverse` and `piggyback` packages.
Expand Down
53 changes: 26 additions & 27 deletions vignettes/ready4use.Rmd
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
---
title: "ready4use"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{ready4use}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```

```{r setup}
library(ready4use)
```
This development version of the ready4use package has been made available as part of the process of testing and documenting the package.


A brief overview of the intended use of ready4use classes and methods is available in the following articles:


- [Retrieve and Disseminate Ready4 Framework Datasets](V_01.html)
- [Pair a Ready4 Framework Dataset and Its Dictionary](V_02.html)
---
title: "ready4use"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{ready4use}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```

```{r setup}
library(ready4use)
```
This development version of the ready4use package has been made available as part of the process of testing and documenting the package.

A brief overview of the intended use of ready4use classes and methods is available in the following articles:

- [Retrieve Ready4 Datasets](V_03.html)
- [Pair a Ready4 Framework Dataset and Its Dictionary](V_02.html)
- [Share Ready4 Datasets](V_01.html)

0 comments on commit 9bba456

Please sign in to comment.