Skip to content

Commit

Permalink
only build vignettes locally
Browse files Browse the repository at this point in the history
  • Loading branch information
dblodgett-usgs committed May 31, 2024
1 parent e466042 commit c199eca
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 4 deletions.
7 changes: 5 additions & 2 deletions vignettes/coastal_units.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ vignette: >
---

```{r setup, include = FALSE}
knitr::opts_chunk$set(
local <- (Sys.getenv("BUILD_VIGNETTES") == "TRUE")
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.width=6,
fig.height=4
fig.height=4,
eval=local
)
options("rgdal_show_exportToProj4_warnings"="none",
rmarkdown.html_vignette.check_title = FALSE)
Expand Down
5 changes: 4 additions & 1 deletion vignettes/refactor_catchment.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ vignette: >
---

```{r setup, include = FALSE}
local <- (Sys.getenv("BUILD_VIGNETTES") == "TRUE")
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.width=6,
fig.height=4
fig.height=4,
eval=local
)
options(rmarkdown.html_vignette.check_title = FALSE)
options(scipen = 9999)
Expand Down
5 changes: 4 additions & 1 deletion vignettes/refactor_nhdplus.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ vignette: >
---

```{r setup, include = FALSE}
local <- (Sys.getenv("BUILD_VIGNETTES") == "TRUE")
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.width=6,
fig.height=4
fig.height=4,
eval=local
)
library(nhdplusTools)
library(hyRefactor)
Expand Down
12 changes: 12 additions & 0 deletions vignettes/split_refactor.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ vignette: >
%\VignetteEncoding{UTF-8}
---

```{r setup, include = FALSE}
local <- (Sys.getenv("BUILD_VIGNETTES") == "TRUE")
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.width=6,
fig.height=4,
eval=local
)
```

A complete refactor workflow is presented in `vignette("refactor_nhdplus")`. This article is used to describe the split-flowlines step in detail. The split flowlines functionality is intended to support either splitting flowlines that are too long at arbitrary locations or splitting flowlines at specific locations such as stream gages or particular model-output locations.

We'll use the sample "New Hope" watershed included in the package and prepare it for processing with `nhdplusTools::prepare_nhdplus()`
Expand Down

0 comments on commit c199eca

Please sign in to comment.