working on pkgdown structure and vignette content #1

Author: fawda123

.github/workflows/R-CMD-check.yaml

@@ -5,7 +5,7 @@ on:
     branches: [main, master]
   pull_request:
 
-name: R-CMD-check.yaml
+name: R-CMD-check
 
 permissions: read-all
 

.github/workflows/pkgdown.yaml

@@ -8,7 +8,7 @@ on:
     types: [published]
   workflow_dispatch:
 
-name: pkgdown.yaml
+name: pkgdown
 
 permissions: read-all
 

_pkgdown.yml

@@ -1,4 +1,24 @@
-url: ~
+url: https://github.com/tbep-tech/slrcsap
 template:
   bootstrap: 5
 
+navbar:
+  structure:
+    left:  [intro, reference, articles, news]
+    right: [search, github]
+
+articles:
+- title: Get Started
+  navbar: ~
+  contents:
+  - tbeploads
+
+reference:
+- title: Get data
+  desc: |
+    Functions for getting data.
+  contents: starts_with('get')
+- title: Plot data
+  desc: |
+    Functions for plotting data.
+  contents: starts_with('plot')

vignettes/figs.Rmd

@@ -15,12 +15,28 @@ knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>",
   message = F, warning = F, 
-  fig.align = 'center'
+  fig.align = 'center', 
+  dpi = 300
 )
 ```
 
 ```{r setup}
 library(slrcsap)
 ```
 
-This vignette provides two figures that support the 2025 update of sea level rise projections for the Tampa Bay region.  The report was created by the Climate Science Advisory Panel (CSAP) to update recommendations from @tbep0519.  
+This vignette provides two figures that support the 2025 update of sea level rise projections for the Tampa Bay region.  The report was created by the Climate Science Advisory Panel (CSAP) to update recommendations from @tbep0519.  
+
+The first figure shows mean monthly sea level at the St. Petersburg, FL tide gauge, with the seasonal cycle removed. Download the figure here](https://raw.githubusercontent.com/tbep-tech/slrcsap/main/docs/fig/tddat.png).
+
+```{r, fig.width = 8, fig.height = 3, fig.cap="1947-2025 monthly mean sea level (MSL) in St. Petersburg, FL, NOAA tide gauge 8726520.  Seasonal cycle removed."}}
+dat <- get_sealevel()
+plot_sealevel(dat)
+```
+
+The second figure shows three sea level rise scenarios for St. Petersburg, FL based on regionally corrected NOAA 2022 curves.  Download the figure [here](https://raw.githubusercontent.com/tbep-tech/slrcsap/main/docs/fig/tddat.png). 
+
+```{r, fig.width = 8, fig.height = 4, fig.cap="Graphic relative sea level change (RSLC) scenarios for St. Petersburg, FL, as calculated using the regionally corrected NOAA 2022 curves"}}
+dat <- get_scenario()
+plot_scenario(dat)
+```
+

vignettes/slrcsap.Rmd

@@ -0,0 +1,37 @@
+---
+title: "Getting started"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Getting started}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>", 
+  warning = F, 
+  message = F, 
+  fig.align = "center"
+)
+```
+
+## Installation
+
+Install the package from [r-universe](http://tbep-tech.r-universe.dev/ui/#builds) as follows. The source code is available on [GitHub](https://github.com/tbep-tech/slrcsap).
+
+```{r eval = F}
+# Install slrcsap in R:
+install.packages('slrcsap', repos = c('https://tbep-tech.r-universe.dev', 'https://cloud.r-project.org'))
+```
+
+Load the package in an R session after installation:
+
+```{r}
+library(slrcsap)
+```
+
+## Usage
+
+text