warning in documentation about need for contiguity of barycentrically…

… transformed parameters
kingaa · Dec 18, 2018 · fa7acb0 · fa7acb0
1 parent 6c654e8
commit fa7acb0
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,8 @@
 Package: pomp2
 Type: Package
 Title: Statistical Inference for Partially Observed Markov Processes
-Version: 2.0.8.0
-Date: 2018-12-17
+Version: 2.0.8.1
+Date: 2018-12-18
 Authors@R: c(person(given=c("Aaron","A."),family="King",
 		role=c("aut","cre"),email="[email protected]"),
 	  person(given=c("Edward","L."),family="Ionides",role=c("aut")),

diff --git a/R/parameter_trans.R b/R/parameter_trans.R
@@ -17,6 +17,7 @@
 ##' @param log names of parameters to be log transformed.
 ##' @param logit names of parameters to be logit transformed.
 ##' @param barycentric names of parameters to be collectively transformed according to the log barycentric transformation.
+##' \strong{Important note:} variables to be log-barycentrically transformed \emph{must be adjacent} in the parameter vector.
 ##' @param \dots ignored.
 ##'
 ##' @details

diff --git a/TODO.md b/TODO.md
@@ -4,7 +4,8 @@
 
 - "guide to upgrading to **pomp** version 2"
 	- ~~discussion of stateful objective functions~~
-	- include before and after codes for the examples from the JSS paper
+	- ~~include before and after codes for the examples from the JSS paper~~
+- for log-barycentric transformations, check that parameter are contiguous
 - more/better examples
 	- need examples of objective function methods
 - more toy models

diff --git a/man/parameter_trans.Rd b/man/parameter_trans.Rd