Skip to content

Commit

Permalink
Merge pull request #32 from mitre/t20-tweak-readme
Browse files Browse the repository at this point in the history
README tweak found during setup testing, closes #20
  • Loading branch information
dchud authored Feb 10, 2021
2 parents dca9ffc + 593a1c5 commit 7842e55
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
5 changes: 4 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -240,9 +240,12 @@ You can install the `growthcleanr` package directly from GitHub using `devtools`
in the R console with:

```{r, eval = FALSE}
devtools::install_github("carriedaymont/growthcleanr")
devtools::install_github("carriedaymont/growthcleanr", ref="main")
```

Note that `ref="main"` is required; the default branch is "main", and must be
referred to explicitly.

### Source-level install for developers

If you want to work with and potentially change the `growthcleanr` code itself,
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,10 @@ data <- as.data.table(source_data)
setkey(data, subjid, param, agedays)

# generate new exclusion flag field using function
cleaned_data <- data[, clean_value:=cleangrowth(subjid, param, agedays, sex, measurement)]
cleaned_data <- data[, clean_value := cleangrowth(subjid, param, agedays, sex, measurement)]

# extract data limited only to values flagged for inclusion:
only_included_data <- cleaned_data[clean_value=='Include']
only_included_data <- cleaned_data[clean_value == "Include"]
```

If our Example dataset above were named `source_data`, examining
Expand Down Expand Up @@ -240,9 +240,12 @@ You can install the `growthcleanr` package directly from GitHub using
`devtools` in the R console with:

``` r
devtools::install_github("carriedaymont/growthcleanr")
devtools::install_github("carriedaymont/growthcleanr", ref="main")
```

Note that `ref="main"` is required; the default branch is “main”, and
must be referred to explicitly.

### Source-level install for developers

If you want to work with and potentially change the `growthcleanr` code
Expand Down

0 comments on commit 7842e55

Please sign in to comment.