Appendix H — Appendix H: Package Vignettes (HTML)

Browser-readable API walkthroughs from snowflakeR and RSnowflake

Keywords

snowflake, R, RStudio, Posit, VS Code, workspace notebooks, snowflakeR, RSnowflake, mlops

H.1 Overview

The narrative chapters in this guide are the learning path. Package vignettes are the API reference walkthroughs — longer, example-heavy documents shipped with each R package (vignettes/*.Rmd → inst/doc/*.html).

This appendix links vignettes on the same GitHub Pages host (snowflake-labs.github.io/snowflakeR/vignettes/...) so they render in the browser like normal HTML — not as raw source.

Source of truth

Vignette source lives in each package repo (snowflakeR/vignettes/, RSnowflake/vignettes/). HTML is built into inst/doc/*.html. At quarto render, scripts/copy_vignette_html_to_site.sh copies both packages’ HTML into _site/vignettes/snowflakeR/ and _site/vignettes/RSnowflake/. Public sync also ships RSnowflake HTML under vignettes-source/rsnowflake/ because the snowflakeR repo does not contain the RSnowflake package tree.

H.2 snowflakeR vignettes (on this site)

These open on the same Hitchhiker’s Guide GitHub Pages host under vignettes/snowflakeR/:

Vignette HTML Guide chapter
getting-started getting-started.html 16 — Connect
setup setup.html 03, 04
rstudio-spcs rstudio-spcs.html 04b — RStudio on SPCS
workspace-notebooks workspace-notebooks.html 06–08
feature-store feature-store.html 17 — Feature Store, 17b — Authoring Feature Views, 17a — Training Data in R
model-registry model-registry.html 18 — Model Registry
experiments experiments.html 19 — Experiments
model-monitoring model-monitoring.html 20 — Monitoring
parallel-dosnowflake parallel-dosnowflake.html Parallel doSnowflake (read first)
many-model-howto many-model-howto.html Many-model

After install.packages / tarball install: browseVignettes("snowflakeR") opens the same content locally.

Reference manual (PDF): system.file("doc/snowflakeR-reference.pdf", package = "snowflakeR") — see Appendix E.

H.3 RSnowflake vignettes (on this site)

Source repo: Snowflake-Labs/RSnowflake. Rendered HTML is copied into this book site the same way as snowflakeR (see How vignettes get into this site).

Vignette HTML Guide chapter
getting-started getting-started.html 12–13
workspace-rsnowflake workspace-rsnowflake.html 14 — Workspace
spcs-custom-services spcs-custom-services.html 04b — RStudio on SPCS

Package repo docs (not vignettes): WORKSPACE_ADBC.md

Do not link RSnowflake vignettes via github.com/.../raw/...

GitHub raw URLs serve HTML as plain text in the browser (you see <!DOCTYPE html> source). Always use the vignettes/RSnowflake/ links on this Pages site, or browseVignettes("RSnowflake") locally.

H.4 How vignettes get into this site

flowchart LR
  RMD[snowflakeR + RSnowflake vignettes]
  GEN[generate_r_docs / R CMD build]
  DOC[inst/doc/*.html]
  SYNC[sync bundles RSnowflake HTML]
  QRT[quarto render book]
  CP[copy_vignette_html_to_site.sh]
  SITE[_site/vignettes/]

  RMD --> GEN --> DOC
  DOC --> SYNC
  SYNC --> CP
  QRT --> CP --> SITE

  1. Edit vignettes in snowflakeR or RSnowflake.
  2. bash sync_snowflakeR_to_public.sh rebuilds snowflakeR inst/doc/, syncs the guide, and copies RSnowflake HTML into vignettes-source/rsnowflake/.
  3. Guide CI runs quarto render then post-render copies both packages into _site/vignettes/snowflakeR/ and _site/vignettes/RSnowflake/.