| Title: | Database of Epidemiological Parameters |
| Version: | 0.1.0 |
| Description: | A data package containing a database of epidemiological parameters. It stores the data for the 'epiparameter' R package. Epidemiological parameter estimates are extracted from the literature. |
| License: | CC0 |
| URL: | https://github.com/epiverse-trace/epiparameterDB/ |
| BugReports: | https://github.com/epiverse-trace/epiparameterDB/issues |
| Depends: | R (≥ 4.0.0) |
| Suggests: | DT, jsonlite, knitr, rmarkdown, spelling, testthat (≥ 3.0.0) |
| VignetteBuilder: | knitr |
| Config/Needs/website: | epiverse-trace/epiversetheme |
| Config/testthat/edition: | 3 |
| Encoding: | UTF-8 |
| Language: | en-GB |
| LazyData: | true |
| RoxygenNote: | 7.3.2 |
| NeedsCompilation: | no |
| Packaged: | 2024-11-27 15:57:54 UTC; lshjl15 |
| Author: | Joshua W. Lambert 
[cre, aut, cph],
Adam Kucharski
[aut],
Carmen Tamayo
[aut] |
| Maintainer: | Joshua W. Lambert <joshua.lambert@lshtm.ac.uk> |
| Repository: | CRAN |
| Date/Publication: | 2024-11-28 11:40:11 UTC |
epiparameterDB: Database of Epidemiological Parameters
Description
A data package containing a database of epidemiological parameters. It stores the data for the 'epiparameter' R package. Epidemiological parameter estimates are extracted from the literature.
Author(s)
Maintainer: Joshua W. Lambert joshua.lambert@lshtm.ac.uk (ORCID) [copyright holder]
Authors:
Adam Kucharski adam.kucharski@lshtm.ac.uk (ORCID)
Carmen Tamayo carmen.tamayo-cuartero@lshtm.ac.uk (ORCID)
See Also
Useful links:
Report bugs at https://github.com/epiverse-trace/epiparameterDB/issues
Format author names for short citation from epidemiological parameter database
Description
Format author names for short citation from epidemiological parameter database
Usage
.cite_author(x)
Arguments
x |
A single |
Value
A character string with the short citation.
Check whether a package is installed
Description
Check whether a package is installed
Usage
.is_pkg_installed(package)
Arguments
package |
string naming the package/name space to load. |
Details
This functions allows testing for when a suggested package dependency is not installed to check if conditional code can be run.
Value
Invisibly returns a boolean logical.
Reads in parameter library from JSON
Description
Read epidemiological parameter database from JSON using
jsonlite::read_json() and returns the list with a <epiparameterDB>
class attribute to validate it has been read using this function.
Usage
.read_db()
Value
list.
A list of epidemiological parameters.
Description
A list of epidemiological parameters.
Usage
epiparameterDB
Format
epiparameterDB
A list of epidemiological parameters read from extdata/parameters.json
with 125 database entries. The object
is tagged with the class attribute <epiparamterDB> to validate the
parameter library has been loaded using the {epiparameterDB} package.