Add citation to BFAST Lite paper

DESCRIPTION

@@ -2,13 +2,13 @@ Package: bfast
 Version: 1.7.0
 Title: Breaks for Additive Season and Trend
 Authors@R: c(person(given = "Jan", family = "Verbesselt", role = c("aut"), email = "Jan.Verbesselt@wur.nl"),
-             person(given = "Dainius", family = "Masiliunas", role = c("aut", "cre"),
+             person(given = "Dainius", family = "Masili\u016Bnas", role = c("aut", "cre"),
              email = "pastas4@gmail.com", comment = c(ORCID = "0000-0001-5654-1277")),
              person(given = "Achim", family = "Zeileis", role = "aut", email = "Achim.Zeileis@R-project.org"),
              person(given = "Rob", family = "Hyndman", role = "ctb", email = "Rob.Hyndman@buseco.monash.edu.au"),
              person(given = "Marius", family = "Appel", role = "aut", email = "marius.appel@uni-muenster.de"),
              person(given = "Martin", family = "Jung", role = "ctb", email = "m.jung@sussex.ac.uk"),
-             person(given = "Andrei", family = "Mirt", role = "ctb", email = "andrei.mirt@wur.nl",
+             person(given = "Andrei", family = "M\u00EEr\u021B", role = "ctb", email = "andrei.mirt@wur.nl",
                     comment = c(ORCID = "0000-0003-3654-2090")),
              person(given = c("Paulo", "Negri"), family = "Bernardino", role = "ctb",
                     email = "paulo.negribernardino@wur.nl"),
@@ -54,3 +54,4 @@ LinkingTo: Rcpp
 RoxygenNote: 7.1.1
 Roxygen: list(markdown = TRUE)
 RdMacros: Rdpack
+Encoding: UTF-8

NEWS

@@ -3,9 +3,11 @@ Changes in Version 1.7.0
   o Added the option to run a structural change test before running bfastlite()
   with two parameters: 'level' and 'type', equivalent to bfast() except that
   anything equal to or below 0 in 'level' will skip the sctest.
-  
+
   o Fixed a bug where bfastpp() would throw an error when annual data is input.
 
+  o Added a reference to the paper describing the BFAST Lite algorithm.
+
 Changes in Version 1.6.1
 
   o Fixed a heap overflow issue in the C++ version of bfastts().

R/bfast-package.R

@@ -106,8 +106,6 @@ NULL
 #' @examples
 #' 
 #' plot(harvest,ylab='NDVI')
-#' # References
-#' citation("bfast")
 #' 
 NULL
 
@@ -169,8 +167,6 @@ NULL
 #' @examples
 #' 
 #' plot(simts)
-#' # References
-#' citation("bfast")
 #' 
 NULL
 

R/bfastlite.R

@@ -37,6 +37,7 @@
 #' contatining information about the likelihood of the time series
 #' having at least one break.}
 #' @author Dainius Masiliunas, Jan Verbesselt
+#' @references \insertRef{dainiusbfastlite}{bfast}
 #' @example examples/bfastlite.r
 #'
 #' @export

inst/CITATION

@@ -1,58 +1,57 @@
-citHeader("To cite bfast in publications use")
-
-citEntry(entry = "Article",
+bibentry(bibtype = "Article",
          title = "Detecting Trend and Seasonal Changes in Satellite Image Time Series",
-         author = personList(as.person("Jan Verbesselt"), 
-	                     as.person("Rob Hyndman"),
-	                     as.person("Glenn Newnham"),
-                             as.person("Darius Culvenor")),
+         author = c(person("Jan", "Verbesselt"), 
+                    person("Rob", "Hyndman"),
+                    person("Glenn", "Newnham"),
+                    person("Darius", "Culvenor")),
          journal      = "Remote Sensing of Environment",
          year         = "2010",
-	 volume       = "114",
-	 number       = "1",
-	 pages        = "106--115",
-	 doi          = "10.1016/j.rse.2009.08.014",
-
-         textVersion = 
-         paste("Jan Verbesselt, Rob Hyndman, Glenn Newnham, Darius Culvenor (2010).", 
-               "Detecting Trend and Seasonal Changes in Satellite Image Time Series.",
-	       "Remote Sensing of Environment, 114(1), 106-115.",
-	       "doi:10.1016/j.rse.2009.08.014"),
+         volume       = "114",
+         number       = "1",
+         pages        = "106--115",
+         doi          = "10.1016/j.rse.2009.08.014",
+         header       = "To cite bfast() in publications, use:"
 )
 
-citEntry(entry = "Article",
+bibentry(bibtype = "Article",
          title = "Phenological Change Detection while Accounting for Abrupt and Gradual Trends in Satellite Image Time Series",
-         author = personList(as.person("Jan Verbesselt"), 
-	                     as.person("Rob Hyndman"),
-	                     as.person("Achim Zeileis"),
-                             as.person("Darius Culvenor")),
+         author = c(person("Jan", "Verbesselt"), 
+                    person("Rob", "Hyndman"),
+                    person("Achim", "Zeileis"),
+                    person("Darius", "Culvenor")),
          journal      = "Remote Sensing of Environment",
          year         = "2010",
-	 volume       = "114",
-	 number       = "12",
-	 pages        = "2970--2980",
-	 doi          = "10.1016/j.rse.2010.08.003",
-         textVersion = 
-         paste("Jan Verbesselt, Rob Hyndman, Achim Zeileis, Darius Culvenor (2010).", 
-               "Phenological Change Detection while Accounting for Abrupt and Gradual Trends in Satellite Image Time Series.",
-	       "Remote Sensing of Environment, 114(12), 2970 - 2980.",
-	       "doi:10.1016/j.rse.2010.08.003"),
+         volume       = "114",
+         number       = "12",
+         pages        = "2970--2980",
+         doi          = "10.1016/j.rse.2010.08.003",
+         header       = "To cite bfast() in publications, use:"
 )
 
-citEntry(entry = "Article",
+bibentry(bibtype = "Article",
          title = "Near real-time disturbance detection using satellite image time series",
-         author = personList(as.person("Jan Verbesselt"),
-                             as.person("Achim Zeileis"),
-                             as.person("Martin Herold")),
+         author = c(person("Jan", "Verbesselt"),
+                    person("Achim", "Zeileis"),
+                    person("Martin", "Herold")),
          journal      = "Remote Sensing of Environment",
          year         = "2012",
          volume       = "123",
          pages        = "98--108",
          doi          = "10.1016/j.rse.2012.02.022",
-         textVersion  = 
-         paste("Jan Verbesselt, Achim Zeileis, Martin Herold (2012).", 
-               "Near real-time disturbance detection using satellite image time series.",
-               "Remote Sensing of Environment, 123, 98 - 108.",
-               "doi:10.1016/j.rse.2012.02.022"),
          header       = "If you use bfastmonitor() or bfastpp(), please cite:"
 )
+
+bibentry(bibtype = "Article",
+         title = "BFAST Lite: A Lightweight Break Detection Method for Time Series Analysis",
+         author = c(person("Dainius", "Masili\u016Bnas"),
+                    person("Nandin-Erdene", "Tsendbazar"),
+                    person("Martin", "Herold"),
+                    person("Jan", "Verbesselt")),
+         journal      = "Remote Sensing",
+         year         = "2021",
+         volume       = "13",
+         issue        = "16",
+         pages        = "3308",
+         doi          = "10.3390/rs13163308",
+         header       = "If you use bfastlite(), please cite:"
+)

inst/REFERENCES.bib

@@ -76,3 +76,18 @@ @article{achimstrucchange
 	pages = {445--466}
 }
 
+
+@article{dainiusbfastlite,
+	title = {{BFAST} {Lite}: {A} {Lightweight} {Break} {Detection} {Method} for {Time} {Series} {Analysis}},
+	volume = {13},
+	shorttitle = {{BFAST} {Lite}},
+	doi = {10.3390/rs13163308},
+	language = {en},
+	number = {16},
+	urldate = {2021-10-06},
+	journal = {Remote Sensing},
+	author = {Masiliūnas, Dainius and Tsendbazar, Nandin-Erdene and Herold, Martin and Verbesselt, Jan},
+	month = jan,
+	year = {2021},
+	pages = {3308}
+}

tests/Examples/bfast-Ex.Rout.save

@@ -344,9 +344,11 @@ Corresponding to breakdates:
 > plot(bp, magstat = "RMSD", magcomp = "harmoncos1", breaks = 2)
 > 
 > # Try with a structural change test
-> bfastlite(datats, level=0.05)
+> bp <- bfastlite(datats, level=0.05)
+> print(bp)
 The structural change test found no breakpoints for this time series,
 therefore processing was skipped.
+> plot(bp)
 > 
 > # Details of the structural change test with the type RE
 > bfastlite(datats, level=0.05, type="RE")$sctest
@@ -828,31 +830,6 @@ Frequency = 365
 > 
 > 
 > plot(harvest,ylab='NDVI')
-> # References
-> citation("bfast")
-
-To cite bfast in publications use
-
-  Jan Verbesselt, Rob Hyndman, Glenn Newnham, Darius Culvenor (2010).
-  Detecting Trend and Seasonal Changes in Satellite Image Time Series.
-  Remote Sensing of Environment, 114(1), 106-115.
-  doi:10.1016/j.rse.2009.08.014
-
-  Jan Verbesselt, Rob Hyndman, Achim Zeileis, Darius Culvenor (2010).
-  Phenological Change Detection while Accounting for Abrupt and Gradual
-  Trends in Satellite Image Time Series. Remote Sensing of Environment,
-  114(12), 2970 - 2980. doi:10.1016/j.rse.2010.08.003
-
-If you use bfastmonitor() or bfastpp(), please cite:
-
-  Jan Verbesselt, Achim Zeileis, Martin Herold (2012). Near real-time
-  disturbance detection using satellite image time series. Remote
-  Sensing of Environment, 123, 98 - 108. doi:10.1016/j.rse.2012.02.022
-
-To see these entries in BibTeX format, use 'print(<citation>,
-bibtex=TRUE)', 'toBibtex(.)', or set
-'options(citation.bibtex.max=999)'.
-
 > 
 > 
 > 
@@ -964,31 +941,6 @@ bibtex=TRUE)', 'toBibtex(.)', or set
 > 
 > 
 > plot(simts)
-> # References
-> citation("bfast")
-
-To cite bfast in publications use
-
-  Jan Verbesselt, Rob Hyndman, Glenn Newnham, Darius Culvenor (2010).
-  Detecting Trend and Seasonal Changes in Satellite Image Time Series.
-  Remote Sensing of Environment, 114(1), 106-115.
-  doi:10.1016/j.rse.2009.08.014
-
-  Jan Verbesselt, Rob Hyndman, Achim Zeileis, Darius Culvenor (2010).
-  Phenological Change Detection while Accounting for Abrupt and Gradual
-  Trends in Satellite Image Time Series. Remote Sensing of Environment,
-  114(12), 2970 - 2980. doi:10.1016/j.rse.2010.08.003
-
-If you use bfastmonitor() or bfastpp(), please cite:
-
-  Jan Verbesselt, Achim Zeileis, Martin Herold (2012). Near real-time
-  disturbance detection using satellite image time series. Remote
-  Sensing of Environment, 123, 98 - 108. doi:10.1016/j.rse.2012.02.022
-
-To see these entries in BibTeX format, use 'print(<citation>,
-bibtex=TRUE)', 'toBibtex(.)', or set
-'options(citation.bibtex.max=999)'.
-
 > 
 > 
 > 
@@ -1021,7 +973,7 @@ bibtex=TRUE)', 'toBibtex(.)', or set
 > cleanEx()
 > options(digits = 7L)
 > base::cat("Time elapsed: ", proc.time() - base::get("ptime", pos = 'CheckExEnv'),"\n")
-Time elapsed:  3.604 0.1 3.736 0.018 0.013 
+Time elapsed:  3.721 0.084 3.84 0.011 0.024 
 > grDevices::dev.off()
 null device 
           1