update pgkd down documentation

renames vignette to standard ggstackplot.Rmd

Author: sebkopf

NEWS.md

@@ -1,8 +1,11 @@
+# ggstackplot (development version)
+
 # ggstackplot 0.4.1
 
 * clarify the behaviour of the `switch_axes` parameter for horizontal stackplots
 * fix issue #30 to enable transformed shared axes
-* update the features vignette (now called explore) with new examples
+* rename the features vignette to the standard package intro vignette (`ggstackplot.Rmd`)
+* update the vignette with additional examples
 * include an example of a horizontal stackplot in the README
 
 # ggstackplot 0.4.0

R/ggstackplot.R

@@ -43,7 +43,7 @@
 #'
 #' @examplesIf interactive()
 #' # many more examples available in the vignette
-#' vignette("Explore", "ggstackplot")
+#' vignette("ggstackplot")
 #'
 #' @export
 #' @returns `ggstackplot()` returns a ggplot with overlayed plot layers

README.Rmd

@@ -30,13 +30,7 @@ Have you ever wanted to create (partly) overlapping line plots with matched colo
 
 ## Installation
 
-To install the current release from [CRAN](https://cran.r-project.org/package=ggstackplot):
-
-```
-install.packages("ggstackplot")
-```
-
-You can also install the development version of ggstackplot from [GitHub](https://github.com/KopfLab/ggstackplot) with:
+Install the latest stable version of ggstackplot from [GitHub](https://github.com/KopfLab/ggstackplot) (the CRAN version may lag behind) with:
 
 ```
 # install.packages("pak")
@@ -152,8 +146,8 @@ dataset2$data |>
 ```
 
 ```{r "geodata-horizontal-2", message = FALSE}
-# or show them side by side (note that this could also be achieved with
-# ggplot facets except for the fine-control and coloring of the different x-axes)
+# or show them side by side (note that this could also be achieved with ggplot
+# facets except for the fine-control and coloring of the different x-axes)
 dataset2$data |> 
   filter(Comp == "C19") |>
   arrange(`Depth sed [m]`) |>
@@ -250,4 +244,4 @@ ggplot2::economics |>
 
 ## What else can I do with ggstackplot?
 
-- check out our **[Vignette](https://ggstackplot.kopflab.org/articles/explore.html)** to explore the package further with detailed examples for all the different features
+- check out our **[Vignette](https://ggstackplot.kopflab.org/articles/ggstackplot.html)** to explore the package further with detailed examples for all the different features

README.md

@@ -25,13 +25,9 @@ retaining the powerful grammar of graphics functionality of ggplots.
 
 ## Installation
 
-To install the current release from
-[CRAN](https://cran.r-project.org/package=ggstackplot):
-
-    install.packages("ggstackplot")
-
-You can also install the development version of ggstackplot from
-[GitHub](https://github.com/KopfLab/ggstackplot) with:
+Install the latest stable version of ggstackplot from
+[GitHub](https://github.com/KopfLab/ggstackplot) (the CRAN version may
+lag behind) with:
 
     # install.packages("pak")
     pak::pak("KopfLab/ggstackplot")
@@ -177,8 +173,8 @@ dataset2$data |>
 <img src="man/figures/README-geodata-horizontal-1.png" width="100%" />
 
 ``` r
-# or show them side by side (note that this could also be achieved with
-# ggplot facets except for the fine-control and coloring of the different x-axes)
+# or show them side by side (note that this could also be achieved with ggplot
+# facets except for the fine-control and coloring of the different x-axes)
 dataset2$data |> 
   filter(Comp == "C19") |>
   arrange(`Depth sed [m]`) |>
@@ -280,6 +276,6 @@ ggplot2::economics |>
 ## What else can I do with ggstackplot?
 
 - check out our
-  **[Vignette](https://ggstackplot.kopflab.org/articles/explore.html)**
+  **[Vignette](https://ggstackplot.kopflab.org/articles/ggstackplot.html)**
   to explore the package further with detailed examples for all the
   different features

_pkgdown.yml

@@ -1,25 +1,27 @@
 title: ggstackplot
 url: https://ggstackplot.kopflab.org
 template:
+  bootstrap: 5
+  light-switch: true
+  bslib:
+    primary: "#306cc9"
   params:
-    bootswatch: simplex
     ganalytics: G-J5NKSWDWXF
-    toc_float: true
-
-development:
-  mode: auto
 
 home:
   strip_header: true
 
+development:
+  mode: auto
+
 navbar:
-  title: ggstackplot
-  type: default
-  left:
-  - text: Explore
-    href: articles/explore.html
-  - text: Reference
-    href: reference/index.html
-  right:
-  - icon: fa-github fa-lg
-    href: https://github.com/kopflab/ggstackplot
+  structure:
+    left:  [intro, reference, news]
+    right: [search, github, lightswitch]
+  components:
+    intro:
+      text: Explore
+      href: articles/ggstackplot.html
+    news:
+      text: News
+      href: news/index.html

man/ggstackplot.Rd

@@ -1,5 +1,5 @@
 ---
-title: "Explore"
+title: "ggstackplot"
 date: "`r Sys.Date()`"
 output: 
   rmarkdown::html_vignette:
@@ -13,12 +13,13 @@ output:
 editor_options:
   chunk_output_type: console
 vignette: >
-  %\VignetteIndexEntry{Explore}
+  %\VignetteIndexEntry{ggstackplot}
   %\VignetteEncoding{UTF-8}
   %\VignetteEngine{knitr::rmarkdown}
 ---
 
 ```{r, include = FALSE}
+# once in quarto this can go into the front matter
 knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>",