Convert dygraphs site to pkgdown

Co-authored-by: jack-davison <davison.jack.jd@gmail.com>

Author: przmv

.Rbuildignore

@@ -5,3 +5,7 @@ examples/.*_files
 docs/
 
 ^\.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^vignettes/articles$

.gitignore

@@ -2,3 +2,4 @@
 .Rhistory
 .RData
 .DS_Store
+docs

DESCRIPTION

@@ -1,40 +1,48 @@
-Package: dygraphs
 Type: Package
+Package: dygraphs
 Title: Interface to 'Dygraphs' Interactive Time Series Charting Library
 Version: 1.1.1.9000
 Authors@R: c(
     person("Dan", "Vanderkam", role = c("aut", "cph"),
-       comment = "dygraphs library in htmlwidgets/lib, https://dygraphs.com/"),
-    person("Petr", "Razumov", role = c("cre", "cph"),
-       email = "ptr@rzmv.su"),
-    person("JJ", "Allaire", role = c("aut")),
-    person(family = "RStudio", role = "cph"),
+           comment = "dygraphs library in htmlwidgets/lib, https://dygraphs.com/"),
+    person("Petr", "Razumov", , "ptr@rzmv.su", role = c("cre", "cph")),
+    person("JJ", "Allaire", role = "aut"),
+    person(, "RStudio", role = "cph"),
     person("Jonathan", "Owen", role = c("aut", "cph")),
     person("Daniel", "Gromer", role = c("aut", "cph")),
     person("Benoit", "Thieurmel", role = c("aut", "cph")),
     person("Kent", "Laukhuf", role = "ctb"),
-    person(family = "jQuery Foundation", role = "cph",
+    person(, "jQuery Foundation", role = "cph",
            comment = "jQuery library"),
-    person(family = "jQuery contributors", role = c("ctb", "cph"),
+    person(, "jQuery contributors", role = c("ctb", "cph"),
            comment = "jQuery library; authors listed in inst/htmlwidgets/lib/jquery/AUTHORS.txt")
-    )
-URL: https://github.com/rstudio/dygraphs
-BugReports: https://github.com/rstudio/dygraphs/issues
+  )
 Description: An R interface to the 'dygraphs' JavaScript charting library
     (a copy of which is included in the package). Provides rich facilities
     for charting time-series data in R, including highly configurable
     series- and axis-display and interactive features like zoom/pan and
     series/point highlighting.
 License: MIT + file LICENSE
+URL: https://rstudio.github.io/dygraphs/,
+    https://github.com/rstudio/dygraphs
+BugReports: https://github.com/rstudio/dygraphs/issues
 Depends:
     R (>= 3.0)
 Imports:
-    magrittr,
-    htmlwidgets (>= 0.6),
     htmltools (>= 0.3.5),
-    zoo (>= 1.7-10),
-    xts (>= 0.9-7)
+    htmlwidgets (>= 0.6),
+    magrittr,
+    xts (>= 0.9-7),
+    zoo (>= 1.7-10)
 Suggests:
     testthat
-Enhances: rmarkdown (>= 0.3.3), shiny (>= 0.10.2.1)
-RoxygenNote: 7.1.1
+Enhances: 
+    rmarkdown (>= 0.3.3),
+    shiny (>= 0.10.2.1)
+Config/Needs/website:
+    RColorBrewer,
+    pkgdown,
+    quantmod
+    tidyverse/tidytemplate,
+Config/roxygen2/version: 8.1.0
+Encoding: UTF-8

NAMESPACE

@@ -47,7 +47,11 @@ importFrom(grDevices,rgb)
 importFrom(htmltools,htmlDependency)
 importFrom(htmlwidgets,JS)
 importFrom(magrittr,"%>%")
-importFrom(stats,end)
-importFrom(stats,start)
-importFrom(zoo,as.yearmon)
-importFrom(zoo,as.yearqtr)
+importFrom(stats,
+  end,
+  start
+)
+importFrom(zoo,
+  as.yearmon,
+  as.yearqtr
+)

NEWS.md

@@ -1,79 +1,62 @@
 # dygraphs (development version)
 
-* Start of development for dygraphs 2.0
-
-dygraphs 1.1.1.7
---------------------------------------------------------------------------------
+# dygraphs 1.1.1.7
 
 * Added the ability for multiple series have different point shapes 
 
-
-dygraphs 1.1.1.6
---------------------------------------------------------------------------------
+# dygraphs 1.1.1.6
 
 * Fix bug which prevented accessing dygraph object in HTMLWidget (#196)
 
+# dygraphs 1.1.1.5
 
-dygraphs 1.1.1.5
---------------------------------------------------------------------------------
-
-* Added pointShape parameter to dyOptions and dySeries function to set point shapes
+* Added pointShape parameter to `dyOptions()` and `dySeries()` function to set point shapes
   other than dots
 
-* Updated dyPlugin behavior to merge same plugin's options for every repeated
+* Updated `dyPlugin()` behavior to merge same plugin's options for every repeated
   function call
 
+# dygraphs 1.1.1.4
 
-dygraphs 1.1.1.4
---------------------------------------------------------------------------------
-
-* Added dyRibbon for creating horizontal band of colors to visualize categorical
+* Added `dyRibbon()` for creating horizontal band of colors to visualize categorical
   variables
 
-* Added dyRebase for creating straw broom charts
+* Added `dyRebase()` for creating straw broom charts
 
-* Updated dyCandlestick with parameter to compress data by time periods
+* Updated `dyCandlestick()` with parameter to compress data by time periods
 
 * Handle display of quarterly scales via moment-quarter plugin
 
-* Make dyUnzoom and dyCrosshair available as package functions
-
+* Make `dyUnzoom()` and `dyCrosshair()` available as package functions
 
-dygraphs 1.1.1.3
---------------------------------------------------------------------------------
+# dygraphs 1.1.1.3
 
-* Added dyCandlestick for creating candlestick/OHLC style charts 
+* Added `dyCandlestick()` for creating candlestick/OHLC style charts 
 
-* Added dyPlotter for defining custom plotters
+* Added `dyPlotter()` for defining custom plotters
 
 * Added Shiny callbacks that react when the user clicks on the graph
 
 * Support for non-date values in shiny input bindings (#132)
 
 * Don't call shiny input bindings if they aren't yet available 
 
-
-dygraphs 1.1.1.2 
---------------------------------------------------------------------------------
+# dygraphs 1.1.1.2 
 
 * Fix for shiny input binding regression introduced in move to instance
   bound widgets (#123)
 
-
-dygraphs 1.1.1-1
---------------------------------------------------------------------------------
+# dygraphs 1.1.1-1
 
 * Create shiny input binding after dygraph is created (#121)
 
-* Reflect color in dyEvent text label (#122)
+* Reflect color in `dyEvent()` text label (#122)
 
+# dygraphs 1.1.1.0
 
-dygraphs 1.1.1.0
---------------------------------------------------------------------------------
+* New `dyPlugin()` function for including dygraphs plugins
 
-* New dyPlugin function for including dygraphs plugins
-
-* Properly handle NULL dyEvent label (#112)
+* Properly handle NULL `dyEvent()` label (#112)
 
 * Handle milliseconds in time events (#85)
 
@@ -82,67 +65,55 @@ dygraphs 1.1.1.0
 * Implement factory method so dygraph is addressable from widget instance:
   e.g. HTMLWidgets.getInstance(document.getElementById('mywidget')).dygraph
 
+# dygraphs 0.9
 
-dygraphs 0.9
---------------------------------------------------------------------------------
-
-* Handle vector data in dyEvent
+* Handle vector data in `dyEvent()`
 
 * Don't do sizeChanged polling (no longer required)
 
 * Option to disable y-axis touch events on mobile devices
 
-
-dygraphs 0.8
---------------------------------------------------------------------------------
+# dygraphs 0.8
 
 * Manage visibility of dygraphs in all types of boostrap tab panes
 
 * Call widget.resize whenever parent size changes
 
-
-dygraphs 0.7
---------------------------------------------------------------------------------
+# dygraphs 0.7
 
 * Ensure that dygraphs are shown properly in R Markdown tabsets 
 
 * Ensure that dygraphs are shown properly in reveal.js presentations
 
-* Fix bug which prevented custom plotters from working in dySeries
-
+* Fix bug which prevented custom plotters from working in `dySeries()`
 
-dygraphs 0.6
---------------------------------------------------------------------------------
+# dygraphs 0.6
 
 * Add support for plotting data with a numeric x-axis (previously only time series
   data was accepted).
 
 * Add new logscale option for numeric x-axis.
 
-* Add stemPlot option to dyOptions and dySeries.
+* Add stemPlot option to `dyOptions()` and `dySeries()`.
 
-
-dygraphs 0.5
---------------------------------------------------------------------------------
+# dygraphs 0.5
 
 * Update embedded dygraphs to version 1.1
 
-* Add support for show='follow' to dyLegend
+* Add support for show='follow' to `dyLegend()`
 
-* Add labelsUTC option to dyOptions
+* Add labelsUTC option to `dyOptions()`
 
 * Change default x axis label width to 60 (necessitated by changes to default
   dygraphs 1.1 x-axis year formatting)
 
 * Allow explicit specification of series periodicity when creating a dygraph 
 
-
-dygraphs 0.4.5
---------------------------------------------------------------------------------
+# dygraphs 0.4.5
 
 * Correct serialization of dates with year < 1000
 
-* Add axis argument to dyShading for horizontal shading
+* Add axis argument to `dyShading()` for horizontal shading
 
 * Add dyLimit function for drawing horizontal limit lines
 
@@ -156,9 +127,7 @@ dygraphs 0.4.5
 * Fix failure to update shiny date range input after graph is 
   re-rendered based on new data or options.
 
-
-dygraphs 0.4.3
---------------------------------------------------------------------------------
+# dygraphs 0.4.3
 
 * Support dynamic updating (i.e. for Shiny reactive outputs) for all dygraphs
   properties (destroy and rebuild the entire dygraph on renderValue)
@@ -167,15 +136,11 @@ dygraphs 0.4.3
 
 * Fix issue where dygraph in ioslides didn't display on slide entry
 
-
-dygraphs 0.4.2
---------------------------------------------------------------------------------
+# dygraphs 0.4.2
 
 * Fix bug with specification of multiple series colors
 
-
-dygraphs 0.4.1
---------------------------------------------------------------------------------
+# dygraphs 0.4.1
 
 * Add useDataTimezone option to enable time display using the underlying
   xts timezone rather than the timezone of the client workstation.
@@ -186,11 +151,9 @@ dygraphs 0.4.1
 
 * Fix bug which caused specification of only a single custom color to fail
 
-* Add explicit showRoller option to dyRoller function
-
+* Add explicit showRoller option to `dyRoller()` function
 
-dygraphs 0.3.3
---------------------------------------------------------------------------------
+# dygraphs 0.3.3
 
 Initial release to CRAN
 

README.md

@@ -8,39 +8,50 @@
 
 <!-- badges: end -->
 
-The dygraphs package is an R interface to the [dygraphs](https://dygraphs.com) JavaScript charting library. It provides rich facilites for charting time-series data in R, including:
+The `{dygraphs}` package is an R interface to the [dygraphs](https://dygraphs.com) JavaScript charting library. It provides rich facilities for charting time-series data in R, including:
 
 - Automatically plots [xts](http://cran.rstudio.com/web/packages/xts/index.html) time series objects (or any object convertible to xts).
+
 - Highly configurable axis and series display (including optional second Y-axis).
-- Rich interactive features including [zoom/pan](https://rstudio.github.io/dygraphs/gallery-range-selector.html) and series/point [highlighting](https://rstudio.github.io/dygraphs/gallery-series-highlighting.html).
-- Display [upper/lower bars](https://rstudio.github.io/dygraphs/gallery-upper-lower-bars.html) (e.g. prediction intervals) around series.
-- Various graph overlays including [shaded regions](https://rstudio.github.io/dygraphs/gallery-shaded-regions.html), [event lines](https://rstudio.github.io/dygraphs/gallery-event-lines.html), and point [annotations](https://rstudio.github.io/dygraphs/gallery-annotations.html).
+
+- Rich interactive features including [zoom/pan](https://rstudio.github.io/dygraphs/articles/gallery-range-selector.html) and series/point [highlighting](https://rstudio.github.io/dygraphs/articles/gallery-series-highlighting.html).
+
+- Display [upper/lower bars](https://rstudio.github.io/dygraphs/articles/gallery-upper-lower-bars.html) (e.g. prediction intervals) around series.
+
+- Various graph overlays including [shaded regions](https://rstudio.github.io/dygraphs/articles/gallery-shaded-regions.html), [event lines](https://rstudio.github.io/dygraphs/articles/gallery-event-lines.html), and point [annotations](https://rstudio.github.io/dygraphs/articles/gallery-annotations.html).
+
 - Use at the R console just like conventional R plots (via RStudio Viewer).
-- Seamless embedding within [R Markdown](https://rstudio.github.io/dygraphs/r-markdown.html) documents and [Shiny](https://rstudio.github.io/dygraphs/shiny.html) web applications.
+
+- Seamless embedding within [R Markdown](https://rstudio.github.io/dygraphs/articles/dygraphs.html#rmarkdown) documents and [Shiny](https://rstudio.github.io/dygraphs/articles/dygraphs.html#shiny) web applications.
 
 ## Installation
 
-The dygraphs package depends on the development version of the [htmlwidgets](https://github.com/ramnathv/htmlwidgets) package so you need to install both packages. You can do this using the **devtools** package as follows:
+You can install this package from CRAN, or the development version from GitHub:
+
+``` r
+# CRAN version
+install.packages('dygraphs')
 
-```S
-devtools::install_github(c("ramnathv/htmlwidgets", "rstudio/dygraphs"))
+# Or Github version
+if (!require('remotes')) install.packages('remotes')
+remotes::install_github('rstudio/dygraphs')
 ```
 
 ## Usage
 
 If you have an xts-compatible time-series object creating an interactive plot of it is as simple as this:
 
-```S
+```r
 dygraph(nhtemp, main = "New Haven Temperatures")
 ```
 
-You can also further customize axes and series display as well as add interacitve features like a range selector:
+You can also further customize axes and series display as well as add interactive features like a range selector:
 
-```S
+```r
 dygraph(nhtemp, main = "New Haven Temperatures") %>%
   dyAxis("y", label = "Temp (F)", valueRange = c(40, 60)) %>%
   dyOptions(fillGraph = TRUE, drawGrid = FALSE) %>%
   dyRangeSelector()
 ```
 
-See the [online documentation](http://rstudio.github.io/dygraphs) for the dygraphs package for additional details and examples.
+See the [online documentation](http://rstudio.github.io/dygraphs) for the `{dygraphs}` package for additional details and examples.