search

cmu-delphi / epiforecast-R

R package to implement and visualize several epidemiological forecasting methods.
GNU General Public License v2.0
21 stars 5 forks source link

Clarification Required: twkde.markovian.sim function #4

Closed siddharthgarg89 closed 5 years ago

siddharthgarg89 commented 5 years ago

Hello Delphi Team,

I was referring to the updated documentation for the epiforecast package and had a few queries regarding the twkde.markovian.sim function -

  1. When I run the code - sim = twkde.markovian.sim(dat, new.dat, baseline=2.1, max.n.sims=100), I get an error message that says - Error in twkde.markovian.sim(dat, new.dat, baseline = 2.1, max.n.sims = 100) : unused argument (new.dat)

  2. The code works fine w/o any error when I use - sim = twkde.markovian.sim(full.dat, baseline=2.1, max.n.sims=100)

Could you please help us out in understanding if the second piece of code is apt and the first one should be discarded or if the first one will work as well post some changes to epiforecast package or its documentation?

brookslogan commented 5 years ago

Thanks for pointing this out; looks like the docstrings themselves are not up to date, not just the manual pdf.

This example works by substituting that call with twkde.markovian.sim(full.dat, baseline=2.1, max.n.sims=100) --- full.dat is defined earlier in the example. See also demo/demo.R for more examples of usage.

siddharthgarg89 commented 5 years ago

Thank you, once again, for the clarification, Logan. Would be possible to have the docstrings updated as well? I understand that this may be an overhead for the Delphi team but it will help us a lot.

brookslogan commented 5 years ago

Sure, the docstrings have been updated to reflect this change in commit 7439cb7fb9c7c3261d5508e699cb2aa9c78d69a0. Additionally, the documentation has been expanded and cleaned up a bit in other areas. Please let me know if you see any additional issues.