From 88a3f099374b4d2603acc2ac5951467cc87d5380 Mon Sep 17 00:00:00 2001 From: Naeem Model Date: Sat, 16 Nov 2024 11:18:40 +0000 Subject: Update README --- README.Rmd | 37 +++++++++++++++++++++++++++++++++---- 1 file changed, 33 insertions(+), 4 deletions(-) (limited to 'README.Rmd') diff --git a/README.Rmd b/README.Rmd index f56e18c..9424e56 100644 --- a/README.Rmd +++ b/README.Rmd @@ -13,8 +13,37 @@ knitr::opts_chunk$set( # Rnaught Rnaught Logo -Rnaught is an R package and web application for estimating the -[basic reproduction number (_R_~0~)]( -https://en.wikipedia.org/wiki/Basic_reproduction_number) of infectious diseases. +Rnaught is an R package and web application for estimating the [basic +reproduction number +(*R*0)](https://en.wikipedia.org/wiki/Basic_reproduction_number) +of infectious diseases. -In progress... +Currently, this estimation can be done in the web application via four +different methods: White and Panago (WP), sequential Bayes (seqB), +incidence decay (ID), and incidence decay and exponential adjustment +(IDEA). + +Datasets can be uploaded as a .csv file, or can be entered manually into +the application. The data is visualized in the application through plots +that show the case counts (either weekly or daily). If multiple datasets +are uploaded/manually entered, the trends corresponding to these +datasets are populated in the same plot and can be compared. This plot +can be exported as a .png file. Further, the dataset entered can be +exported into a .csv file. Two sample datasets are included: weekly +Canadian COVID-19 case count data from March 3rd, 2020 to March 31st, +2020, and weekly Ontario COVID-19 case count data from March 3rd, 2020 +to March 31st, 2020. + +To estimate the basic reproductive number, the user can choose their +preferred estimator, and if applicable, must enter the known serial +interval prior to estimation. If multiple estimates of the basic +reproductive number are calculated, they are all included in a table +where each row represents an estimate. If multiple datasets are being +considered, the basic reproductive number is estimated for all datasets +and the columns of the table correspond to the different datasets +uploaded into the application. The table also consists of a column +corresponding to the value of the [serial interval +(SI)](https://en.wikipedia.org/wiki/Serial_interval). This table can be +exported as a .csv file. + +In progress… -- cgit v1.2.3