-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.qmd
145 lines (100 loc) · 5.61 KB
/
README.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
---
title: "serocalculator"
format: gfm
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
------------------------------------------------------------------------
<!-- badges: start -->
[](https://github.com/UCD-SERG/serocalculator/actions/workflows/R-CMD-check.yaml)
[](https://codecov.io/gh/UCD-SERG/serocalculator)
<!-- badges: end -->
```{r svg}
#| echo: false
#| label: fig-qr-code
library(qrcode)
code <- qr_code("https://ucd-serg.github.io/serocalculator/")
generate_svg(code, filename = "man/figures/qr.svg")
```
{#fig-website-QR}
Antibody levels measured in a cross–sectional population sample can be translated into an estimate of the frequency with which seroconversions (infections) occur in the sampled population.
In other words, the presence of many high antibody titers indicates that many individuals likely experienced infection recently and the burden of disease is high in the population,
while low titers indicate a low frequency of infections in the sampled population and therefore a lower burden of disease.
The **serocalculator** package was designed to use the longitudinal response characteristics
using a set of modeled parameters characterizing the longitudinal response of the selected serum antibodies.
More details on the underlying methods can be found in [Getting Started](https://ucd-serg.github.io/serocalculator/articles/serocalculator.html).
## Installing R
The **serocalculator** package is designed to be used in [R](https://www.r-project.org/),
which is a free, open-source software environment for statistical computing and graphics.
The end user of this package must have access to a working installation of the R software.
We recommend installing [base R](https://cran.r-project.org/) and a Graphical User Interface (GUI) for R such as [RStudio](https://posit.co/products/open-source/rstudio/).
If you need to download and install R and/or RStudio, we recommend following the tutorial below from *Hands On Programming in R* by Garrett Grolemund:
**Installing R and RStudio**: https://rstudio-education.github.io/hopr/starting.html
## Installing the Serocalculator Package
The **serocalculator** package must be installed in R before first use.
```r{eval=FALSE}
# Install package
install.packages("serocalculator")
```
### Post-installation
Successful installation can be confirmed by loading the package into the RStudio workspace and exploring help files and manuals distributed with the package:
```r{eval=FALSE}
# Load package "seroincidence".
library(serocalculator)
# Show R help for the package.
?serocalculator
```
Additionally, most package details can be found when executing the following commands:
```r{eval=FALSE}
# Show description.
packageDescription("serocalculator")
# Show citation.
citation("serocalculator")
```
### Development Version
To install the development version, you must install the **devtools** R package and then download **serocalculator** from [GitHub](https://github.com/). Enter the code below into the R console to install both packages.
```r{eval=FALSE}
# Install the devtools package and the development version of serocalculator
install.packages("devtools")
devtools::install_github("ucd-serg/serocalculator")
```
#### A Note for Windows Users
Before launching the development version of **serocalculator**, Windows users will need to install Rtools, which contains a collection of tools for building and employing R packages that are still in development.
This can be done either:
(1) [during the *devtools* package installation](#during-devtools-installation), **or**
(2) [independently](#independently), if *devtools* is already installed.
##### During devtools installation
When prompted to install additional build tools, select "Yes" and Rtools will be installed.
![Click Yes to install Rtools along with the *devtools* package][id]
[id]: man/figures/Rtools1.png
:::{.callout-note}
After installing Rtools, you may need to restart RStudio before continuing to install `serocalculator`.
:::
##### Independently:
1. Download Rtools from https://cran.r-project.org/bin/windows/Rtools/
2. Run the installer
* During the Rtools installation you may see a window asking you to “Select Additional Tasks”.
* Do **not** select the box for “Edit the system PATH”. devtools and RStudio should put Rtools on the PATH automatically when it is needed.
* **Do** select the box for “Save version information to registry”. It should be selected by default.
## Getting Help
If you have questions about using this software package,
please use the [Q&A forum](https://github.com/UCD-SERG/serocalculator/discussions/categories/q-a).
If you encounter a clear bug, please file an issue
with a [minimal reproducible example](https://reprex.tidyverse.org/)
on [GitHub](https://github.com/UCD-SERG/serocalculator/issues).
Another great resource is **The Epidemiologist R Handbook**,
which includes an introductory page on asking for help with R packages via GitHub:
https://epirhandbook.com/en/getting-help.html
## Contributing to this project
We welcome contributions to this project -
anything from typo corrections to new features.
Please see our
[Contributor guide](https://ucd-serg.github.io/serocalculator/CONTRIBUTING.html#fixing-typos)
for more information.