Many of these updates were a result of finished the package tutorial; there were several TODO items in the original draft, and these have all been addressed one way or another. Specifically:
Changed the default cooling.type argument in mif2() to "geometric" in order to be consistent with the pomp package.
Added format argument to coef.panelPomp, with options c('vector', 'list'). The default behavior is unchanged, but now the coef method can be used to extract parameters in list format. This functionality makes pparams() obsolete, so it has been removed from the package.
Renamed the pParams() function to toParamList() for clarity.
Modified the function toVectorPparams() so that it returns a vector instead of a 1-row data.frame. For clarity, the function has been renamed: toParamVec(). It is an inverse of the toParamList() function.
Website updates
Added a complete package tutorial: vignettes/articles/package_tutorial/tutorial.pdf. As per recommendation of Hadley Wickham, the entire articles package is in the .Rbuildignore. This way, articles are not built with the package and are only available on the website, and the source code for this particular article is contained in the sub-folder vignettes/articles/package_tutorial.
The website will now render on any push to the master branch that effects the inst/NEWS or inst/NEWS.Rd files.
Package Updates
Many of these updates were a result of finished the package tutorial; there were several TODO items in the original draft, and these have all been addressed one way or another. Specifically:
cooling.typeargument inmif2()to"geometric"in order to be consistent with thepomppackage.formatargument tocoef.panelPomp, with optionsc('vector', 'list'). The default behavior is unchanged, but now thecoefmethod can be used to extract parameters in list format. This functionality makespparams()obsolete, so it has been removed from the package.pParams()function totoParamList()for clarity.toVectorPparams()so that it returns a vector instead of a 1-rowdata.frame. For clarity, the function has been renamed:toParamVec(). It is an inverse of thetoParamList()function.Website updates
Added a complete package tutorial:
vignettes/articles/package_tutorial/tutorial.pdf. As per recommendation of Hadley Wickham, the entire articles package is in the.Rbuildignore. This way, articles are not built with the package and are only available on the website, and the source code for this particular article is contained in the sub-foldervignettes/articles/package_tutorial.The website will now render on any push to the master branch that effects the
inst/NEWSorinst/NEWS.Rdfiles.