Fix issue with NULL handling in breakspoints.breakpointsfull

Author: GreatEmerald

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: strucchangeRcpp
-Version: 1.5-4-1.0.1
+Version: 1.5-4-1.0.2
 Title: Testing, Monitoring, and Dating Structural Changes: C++ Version
 Authors@R: c(person(given = "Dainius", family = "Masiliunas", role = c("aut", "cre"),
              email = "pastas4@gmail.com", comment = c(ORCID = "0000-0001-5654-1277")),

NEWS

@@ -1,3 +1,11 @@
+Changes in Version 1.5-4-1.0.2
+
+  o Fix issue where breakpoints.breakpointsfull(breaks=NULL) would return
+  one break when the optimal number of breaks is 0.
+  o Update documentation of 'breakpoints' to note the special handling of
+  the NULL value in breakpoints.breakpointsfull and the fact that the
+  information criterion is configurable.
+
 Changes in Version 1.5-4-1.0.1
 
   o Switch from deprecated arma::is_finite to member .is_finite (thanks to

R/breakpoints.R

@@ -220,6 +220,8 @@ breakpoints.breakpointsfull <- function(obj, breaks = c("BIC", "LWZ", "RSS", "al
       stop("Please enter an integer number of breaks")
   } else if (is.null(breaks)) {
     breaks <- length(obj$breakpoints)
+    if (breaks == 1 && is.na(obj$breakpoints))
+      breaks <- 0
   } else
   {
     breakstat <- match.arg(breaks)

man/breakpoints.Rd

@@ -53,7 +53,8 @@
     or a string specifying the information criterion to use to automatically determine
     the optimal number of breaks (see also \code{\link{logLik}}).
     \code{"all"} means the maximal number allowed by \code{h} is used.
-    \code{NULL} is treated as the default of the \code{breakpoints} function (i.e. BIC).}
+    In \code{breakpoints.breakpointsfull}, \code{NULL} extracts the optimal number of
+    breaks as determined by the initial \code{breakpoints} call.}
   \item{data}{an optional data frame containing the variables in the model. By
      default the variables are taken from the environment which \code{breakpoints} is
      called from.}
@@ -137,7 +138,8 @@
   series properties and the associated RSS) but not the triangular RSS
   matrix and related extractor functions. The set of breakpoints which
   is associated by default with a \code{"breakpointsfull"} object is
-  the minimum BIC partition.
+  the partition determined by the information criterion defined by the
+  \code{breaks} argument.
 
   Breakpoints are the number of observations that are the last in one
   segment, it is also possible to compute the corresponding \code{breakdates}