Skip to content

Commit

Permalink
Merge pull request #305 from UCD-SERG/pr/234/patch-01
Browse files Browse the repository at this point in the history
polishing edits on pr #234
  • Loading branch information
chrisorwa authored Oct 7, 2024
2 parents 399fdf4 + ba731ac commit 44042fc
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 13 deletions.
7 changes: 6 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## New features

* Improved error messaging for `autoplot.pop_data()` (#234).

* Clarified package installation instructions in scrub typhus vignette (#234).

* Updated `simulate_xsectionalData.Rmd()` (linting, removing deprecated functions).

* Added default value for `antigen_isos` argument in `log_likelihood()` (#286)
Expand All @@ -18,6 +22,8 @@

## Developer-facing changes

* Added `test-autoplot.pop_data` test (#234)

* initialized [`lintr`](https://lintr.r-lib.org/) with `lintr::use_lint()` (#278)

* created unit test for `df_to_array()` (#276)
Expand All @@ -44,7 +50,6 @@ including:
- lint changed files (#256)

# serocalculator 1.2.0
* Added `test-autoplot.pop_data` test

* Added `test-summary.pop_data` test

Expand Down
24 changes: 12 additions & 12 deletions vignettes/articles/scrubTyphus_example.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -40,26 +40,26 @@ knitr::opts_chunk$set(
)
```


```{r setup, message=FALSE}
install.packages("devtools")
devtools::install_github("ucd-serg/serocalculator", eval = FALSE)
```


### Load packages
The first step in conducting this analysis is to load our necessary packages. If you haven't installed already, you will need to do so before loading.
The first step in conducting this analysis is to load our necessary packages.
If you haven't installed already, you will need to do so before loading.
We will also need to have the `tidyverse` and `mixtools` packages installed
for data manipulation and graphics operations we will perform in this vignette.
Please see the websites for
[`serocalculator`](https://ucd-serg.github.io/serocalculator/#installing-the-serocalculator-package),
[`tidyverse`](https://tidyverse.tidyverse.org/#installation),
and [`mixtools`](https://github.com/dsy109/mixtools?tab=readme-ov-file#installation)
for guidance on installing these packages into your R package library.

Once all three of those packages are installed, we can load them into
our active R session environment:

```{r load_packages}
library(serocalculator)
library(devtools)
install.packages("tidyverse", eval = FALSE)
library(tidyverse)
install.packages("mixtools", eval = FALSE)
library(mixtools)
```


### Load data

Pathogen-specific sample datasets, noise parameters, and longitudinal antibody dynamics for **serocalculator** are available on the [Serocalculator Repository](https://osf.io/ne8pc/) on Open Science Framework (OSF). We will pull this data directly into our R environment.
Expand Down

0 comments on commit 44042fc

Please sign in to comment.