Skip to content

Commit fa60abe

Browse files
committed
correct/update FAQ
1 parent b2d46a4 commit fa60abe

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

vignettes/FAQ.Rmd

+9-6
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,11 @@ By letting us know when messages are confusing or uninformative, you help us to
8787
## I am running a piece of **pomp** code I got from a guy, but I get errors. What is going on? {#old-code}
8888

8989
Of course, there could be many reasons for this.
90-
However, you should know that **pomp** version 2 made many changes to the **pomp** interface so that older code will not run under versions ≥ 2.
91-
See the [**pomp** version 2 upgrade guide](./upgrade_guide.html) for information on how to fix broken code from earlier versions.
90+
However, you should know that each time the major version number for the packageincreases (e.g., from 5.11 to 6.1), at least one change has been introduced that has the potential to break existing code.
91+
Consult the [news blog](./blog.html) (including the [blog archive](./archive.html) if the code you are testing is more than a few months old):
92+
these contain succinct summaries of the changes associated with each release.
93+
Note also that the [online manual](https://kingaa.github.io/manuals/pomp/) is kept up to date.
94+
There is also the [**pomp** version 2 upgrade guide](./upgrade_guide.html) which gives information on how to update codes from versions <2.
9295

9396
## Where in the peer-reviewed literature is **pomp** described?
9497

@@ -279,7 +282,7 @@ dmeas <- Csnippet("
279282
280283
dat |>
281284
pomp(
282-
time="day",t0=0,
285+
times="day",t0=0,
283286
rprocess=euler(sir_step,delta.t=1/12),
284287
rinit=sir_init,
285288
rmeasure=rmeas,
@@ -388,7 +391,7 @@ day,B
388391
389392
dat |>
390393
pomp(
391-
time="day",t0=-8,
394+
times="day",t0=-8,
392395
rprocess=euler(sir_step,delta.t=1/12),
393396
rinit=sir_init,
394397
rmeasure=rmeas,
@@ -437,7 +440,7 @@ dat |>
437440
bind_rows(c(day=0,B=NA)) |>
438441
arrange(day) |>
439442
pomp(
440-
time="day",t0=-8,
443+
times="day",t0=-8,
441444
rprocess=euler(sir_step,delta.t=1/12),
442445
rinit=sir_init,
443446
rmeasure=rmeas,
@@ -902,7 +905,7 @@ dmeas <- Csnippet("
902905

903906
```{r include=FALSE}
904907
## Check the above C snippet.
905-
pomp(data.frame(t=1:10,D1=1:10,D2=2),time='t',t0=0,dmeasure=dmeas,
908+
pomp(data.frame(t=1:10,D1=1:10,D2=2),times='t',t0=0,dmeasure=dmeas,
906909
statenames=c("N1","N2"),paramnames=c("rho1","rho2","k"))
907910
```
908911

vignettes/FAQ.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ <h2 number="1.2"><span class="header-section-number">1.2</span> What’s the pro
260260
<p>To cite the ‘pomp’ package in publications, use:</p>
261261
<p>A. A. King, D. Nguyen, E. L. Ionides (2016). Statistical Inference for Partially Observed Markov Processes via the R Package pomp. Journal of Statistical Software 69(12): 1–43. <a href="DOI:10.18637/jss.v069.i12" class="uri">DOI:10.18637/jss.v069.i12</a>.</p>
262262
<p>Additionally, consider citing the package itself:</p>
263-
<p>A. A. King, E. L. Ionides, C. M. Breto, S. P. Ellner, M. J. Ferrari, S. Funk, S. G. Johnson, B. E. Kendall, M. Lavine, D. Nguyen, E. B. O’Dea, D. C. Reuman, H. Wearing, and S. N. Wood (2024). pomp: Statistical Inference for Partially Observed Markov Processes. (R package, version 5.11.1.0). <a href="https://kingaa.github.io/pomp/" class="uri">https://kingaa.github.io/pomp/</a></p>
263+
<p>A. A. King, E. L. Ionides, C. M. Breto, S. P. Ellner, M. J. Ferrari, S. Funk, S. G. Johnson, B. E. Kendall, M. Lavine, D. Nguyen, E. B. O’Dea, D. C. Reuman, H. Wearing, and S. N. Wood (2024). pomp: Statistical Inference for Partially Observed Markov Processes. (R package, version 6.0.1.0). <a href="https://kingaa.github.io/pomp/" class="uri">https://kingaa.github.io/pomp/</a></p>
264264
<p>You can get this information by executing <code>citation(&quot;pomp&quot;)</code> in an <strong>R</strong> session. LaTeX users can get a BibTeX entry for these publications by executing <code>toBibtex(citation(&quot;pomp&quot;))</code>.</p>
265265
<p>If you use <strong>pomp</strong> in a publication, please take a moment to let us know! Send an email with the citation, and we’ll include it in <a href="./biblio.html">the bibliography</a>.</p>
266266
</div>
@@ -271,7 +271,7 @@ <h2 number="1.3"><span class="header-section-number">1.3</span> I have an error
271271
</div>
272272
<div id="old-code" class="section level2" number="1.4">
273273
<h2 number="1.4"><span class="header-section-number">1.4</span> I am running a piece of <strong>pomp</strong> code I got from a guy, but I get errors. What is going on?</h2>
274-
<p>Of course, there could be many reasons for this. However, you should know that <strong>pomp</strong> version 2 made many changes to the <strong>pomp</strong> interface so that older code will not run under versions ≥ 2. See the <a href="./upgrade_guide.html"><strong>pomp</strong> version 2 upgrade guide</a> for information on how to fix broken code from earlier versions.</p>
274+
<p>Of course, there could be many reasons for this. However, you should know that each time the major version number for the packageincreases (e.g., from 5.11 to 6.1), at least one change has been introduced that has the potential to break existing code. Consult the <a href="./blog.html">news blog</a> (including the <a href="./archive.html">blog archive</a> if the code you are testing is more than a few months old): these contain succinct summaries of the changes associated with each release. Note also that the <a href="https://kingaa.github.io/manuals/pomp/">online manual</a> is kept up to date. There is also the <a href="./upgrade_guide.html"><strong>pomp</strong> version 2 upgrade guide</a> which gives information on how to update codes from versions &lt;2.</p>
275275
</div>
276276
<div id="where-in-the-peer-reviewed-literature-is-pomp-described" class="section level2" number="1.5">
277277
<h2 number="1.5"><span class="header-section-number">1.5</span> Where in the peer-reviewed literature is <strong>pomp</strong> described?</h2>
@@ -430,7 +430,7 @@ <h2 number="3.3"><span class="header-section-number">3.3</span> How do I deal wi
430430
<span id="cb6-28"><a href="#cb6-28" aria-hidden="true"></a></span>
431431
<span id="cb6-29"><a href="#cb6-29" aria-hidden="true"></a>dat <span class="op">|</span><span class="er">&gt;</span></span>
432432
<span id="cb6-30"><a href="#cb6-30" aria-hidden="true"></a><span class="st"> </span><span class="kw">pomp</span>(</span>
433-
<span id="cb6-31"><a href="#cb6-31" aria-hidden="true"></a> <span class="dt">time=</span><span class="st">&quot;day&quot;</span>,<span class="dt">t0=</span><span class="dv">0</span>,</span>
433+
<span id="cb6-31"><a href="#cb6-31" aria-hidden="true"></a> <span class="dt">times=</span><span class="st">&quot;day&quot;</span>,<span class="dt">t0=</span><span class="dv">0</span>,</span>
434434
<span id="cb6-32"><a href="#cb6-32" aria-hidden="true"></a> <span class="dt">rprocess=</span><span class="kw">euler</span>(sir_step,<span class="dt">delta.t=</span><span class="dv">1</span><span class="op">/</span><span class="dv">12</span>),</span>
435435
<span id="cb6-33"><a href="#cb6-33" aria-hidden="true"></a> <span class="dt">rinit=</span>sir_init,</span>
436436
<span id="cb6-34"><a href="#cb6-34" aria-hidden="true"></a> <span class="dt">rmeasure=</span>rmeas,</span>
@@ -518,7 +518,7 @@ <h2 number="3.4"><span class="header-section-number">3.4</span> I have t0 much l
518518
<span id="cb9-45"><a href="#cb9-45" aria-hidden="true"></a></span>
519519
<span id="cb9-46"><a href="#cb9-46" aria-hidden="true"></a>dat <span class="op">|</span><span class="er">&gt;</span></span>
520520
<span id="cb9-47"><a href="#cb9-47" aria-hidden="true"></a><span class="st"> </span><span class="kw">pomp</span>(</span>
521-
<span id="cb9-48"><a href="#cb9-48" aria-hidden="true"></a> <span class="dt">time=</span><span class="st">&quot;day&quot;</span>,<span class="dt">t0=</span><span class="op">-</span><span class="dv">8</span>,</span>
521+
<span id="cb9-48"><a href="#cb9-48" aria-hidden="true"></a> <span class="dt">times=</span><span class="st">&quot;day&quot;</span>,<span class="dt">t0=</span><span class="op">-</span><span class="dv">8</span>,</span>
522522
<span id="cb9-49"><a href="#cb9-49" aria-hidden="true"></a> <span class="dt">rprocess=</span><span class="kw">euler</span>(sir_step,<span class="dt">delta.t=</span><span class="dv">1</span><span class="op">/</span><span class="dv">12</span>),</span>
523523
<span id="cb9-50"><a href="#cb9-50" aria-hidden="true"></a> <span class="dt">rinit=</span>sir_init,</span>
524524
<span id="cb9-51"><a href="#cb9-51" aria-hidden="true"></a> <span class="dt">rmeasure=</span>rmeas,</span>
@@ -555,7 +555,7 @@ <h2 number="3.4"><span class="header-section-number">3.4</span> I have t0 much l
555555
<span id="cb12-4"><a href="#cb12-4" aria-hidden="true"></a><span class="st"> </span><span class="kw">bind_rows</span>(<span class="kw">c</span>(<span class="dt">day=</span><span class="dv">0</span>,<span class="dt">B=</span><span class="ot">NA</span>)) <span class="op">|</span><span class="er">&gt;</span></span>
556556
<span id="cb12-5"><a href="#cb12-5" aria-hidden="true"></a><span class="st"> </span><span class="kw">arrange</span>(day) <span class="op">|</span><span class="er">&gt;</span></span>
557557
<span id="cb12-6"><a href="#cb12-6" aria-hidden="true"></a><span class="st"> </span><span class="kw">pomp</span>(</span>
558-
<span id="cb12-7"><a href="#cb12-7" aria-hidden="true"></a> <span class="dt">time=</span><span class="st">&quot;day&quot;</span>,<span class="dt">t0=</span><span class="op">-</span><span class="dv">8</span>,</span>
558+
<span id="cb12-7"><a href="#cb12-7" aria-hidden="true"></a> <span class="dt">times=</span><span class="st">&quot;day&quot;</span>,<span class="dt">t0=</span><span class="op">-</span><span class="dv">8</span>,</span>
559559
<span id="cb12-8"><a href="#cb12-8" aria-hidden="true"></a> <span class="dt">rprocess=</span><span class="kw">euler</span>(sir_step,<span class="dt">delta.t=</span><span class="dv">1</span><span class="op">/</span><span class="dv">12</span>),</span>
560560
<span id="cb12-9"><a href="#cb12-9" aria-hidden="true"></a> <span class="dt">rinit=</span>sir_init,</span>
561561
<span id="cb12-10"><a href="#cb12-10" aria-hidden="true"></a> <span class="dt">rmeasure=</span>rmeas,</span>

0 commit comments

Comments
 (0)