cmu-delphi / epidatr

Delphi Epidata API R Client
https://cmu-delphi.github.io/epidatr/
Other
1 stars 5 forks source link

Add examples to timeset documentation #203

Open capnrefsmmat opened 10 months ago

capnrefsmmat commented 10 months ago

The timeset documentation describes the valid inputs for arguments like time_values:

https://github.com/cmu-delphi/epidatr/blob/ee952c518ac0cf7cc25083b6c54a0b284d2c3448/R/model.R#L65-L88

This should include an @examples section with examples of various different timesets, with labels saying how they're interpreted.

Since timesets are linked in every API function that takes them as input, this should serve as the primary documentation of how to set dates, instead of deferring to epirange and other things.