Minor improvements to documentation

NEWS.md

@@ -1,5 +1,13 @@
 # NEWS for ggseas
 
+## 0.5.1
+* Minor improvements to documentation eg giving the vignette a title.
+
+## 0.5.0
+* ggsdc gets a facet.titles argument
+* ggsdc will now work with tibbles
+* when a colour is maped to a variable that is a factor, ggsdc will now preserve the ordering of levels in that factor for drawing legends etc
+* added a vignette
 
 ## 0.4.0
 * Seasonal adjustment functions will estimate frequency and (for X13 related purposes) start from the data if possible.  If the x variable is a Date rather than numeric, user still needs to provide start and frequency.

pkg/DESCRIPTION

@@ -1,6 +1,6 @@
 Package: ggseas
 Title: 'stats' for Seasonal Adjustment on the Fly with 'ggplot2'
-Version: 0.5.0
+Version: 0.5.0.9000
 Authors@R: c(
    person("Peter", "Ellis", , "peter.ellis2013nz@gmail.com", c("aut", "cre")),
    person("Christophe", "Sax", role = "ctb")

pkg/R/ggseas.R

@@ -0,0 +1,14 @@
+#' Seasonal decomposition on the fly
+#' 
+#' ggseas allows you to perform seasonal decomposition on the fly as part of a `ggplot2` pipeline.
+#' 
+#' Two main sets of functions are provided:
+#' 
+#' \itemize{
+#'     \item{\code{stat_seas()}, \code{stat_stl()} and friends do seasonal adjustment, indexing, rolling averages and by default render a line geom.
+#'     You can consider these as taking the place of \code{geom_line()} in the ggplot2 pipeline}
+#'     \item{\code{ggsdc()} goes where \code{ggplot()} normally does (ie at the beginning of the pipeline) and creates a graphic with four facets for the original data, trend, seasonal and random components}
+#' 
+#' }
+#' 
+"_PACKAGE"

pkg/R/misc_doc.R

@@ -17,8 +17,6 @@
 
 
 
-
-
 #' New Zealand Balance of Payments major components 1971Q2 to 2015Q2
 #' 
 #' New Zealand's "BPM6 Quarterly, Balance of payments major components (Qrtly-Mar/Jun/Sep/Dec)".

pkg/vignettes/ggsdc.Rmd

@@ -4,7 +4,7 @@ author: "Peter Ellis"
 date: "`r Sys.Date()`"
 output: rmarkdown::html_vignette
 vignette: >
-  %\VignetteIndexEntry{Vignette Title}
+  %\VignetteIndexEntry{ggsdc - seasonal decomposition on the fly}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---