From 21dad168de1f98ccdbebce15e72f746252c8c308 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 25 Apr 2024 10:55:59 +0000 Subject: [PATCH] Automatic readme update --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 76b4279a3..48e989c3c 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ To load the library of epidemiological parameters into `R`: epidists <- epidist_db() #> Returning 122 results that match the criteria (99 are parameterised). #> Use subset to filter by entry variables or single_epidist to return a single entry. -#> To retrieve the short citation for each use the 'get_citation' function +#> To retrieve the citation for each use the 'get_citation' function epidists #> List of objects #> Number of entries in library: 122 @@ -80,7 +80,7 @@ influenza_incubation <- epidist_db( #> Distribution of the Incubation Periods of Human Avian Influenza A(H7N9) #> Virus Infections." _American Journal of Epidemiology_. #> doi:10.1093/aje/kwv115 .. -#> To retrieve the short citation use the 'get_citation' function +#> To retrieve the citation use the 'get_citation' function influenza_incubation #> Disease: Influenza #> Pathogen: Influenza-A-H7N9 @@ -127,13 +127,20 @@ or the median and range of the data. This can be done for: ## Contributing to library of epidemiological parameters If you would like to contribute to the different epidemiological -parameters stored in the `{epiparameter}` package, you can access the -[google -sheet](https://docs.google.com/spreadsheets/d/1zVpaaKkQ7aeMdRN2r0p-W4d2TtccL5HcIOp_w-lfkEQ/edit?usp=sharing) -and add your data. This spreadsheet contains two example entries as a -guide to what fields can accept. See also the data dictionary (either -yaml or JSON files) in the `{epiparameter}` package (in inst/extdata) -for explanation of accepted entries for each column. +parameters stored in the `{epiparameter}` package, you can add data to a +public [google +sheet](https://docs.google.com/spreadsheets/d/1zVpaaKkQ7aeMdRN2r0p-W4d2TtccL5HcIOp_w-lfkEQ/edit?usp=sharing). +This spreadsheet contains two example entries as a guide to what fields +can accept. We are monitoring this sheet for new entries that will +subsequently be included in the package. + +Alternatively, parameters can be added to the [JSON file holding the +data](https://github.com/epiverse-trace/epiparameter/blob/main/inst/extdata/parameters.json) +base directly via a Pull Request. + +You can find explanation of accepted entries for each column in the +[data +dictionary](https://github.com/epiverse-trace/epiparameter/blob/main/inst/extdata/data_dictionary.json). ## Help