grattan / covidReff

Simulating Covid reproduction in a partially vaccinated population
Other
4 stars 1 forks source link

Documentation of `simulate_covid` invites the audience to bring their own interpretation to the work a bit too much #8

Closed HughParsonage closed 3 years ago

HughParsonage commented 3 years ago

Clarify the expected result

Bit too minimal:

#' @return A \code{tibble} object.

params rely on the name

The names look good but the description only provides the default. Specify:

  1. The object type and length
  2. The range of acceptable values, including the interaction with other params.
  3. The meaning.
  4. An example value and what it would mean.

Note some of the documentation will require \code{} when underscores are used.

wfmackey commented 3 years ago

Documentation added in https://github.com/grattan/covidReff/commit/62e9cc2c61a017362bfbd5f59f729ad448924485