Add note explaining the double key in options()

coatless-tutorials · Jan 25, 2024 · 1c98097 · 1c98097
1 parent 8081912
commit 1c98097
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -203,6 +203,14 @@ options(
 webr::install("pkgname")
 ```
 
+> [!NOTE]
+>
+> This is different than the `repos` option one would usually set since
+> webR only checks the [`webr_pkg_repos`
+> key](https://github.com/r-wasm/webr/blob/010223433079d1a9ef3eb9bbf73d8eccb38e6adc/packages/webr/R/install.R#L23);
+> however, other R functions like `available.packages()` check the
+> `repos` parameter.
+
 Alternatively, the `repos` can be specified each time:
 
 ``` r

diff --git a/README.qmd b/README.qmd
@@ -172,6 +172,11 @@ options(
 webr::install("pkgname")
 ```
 
+:::{.callout-note}
+This is different than the `repos` option one would usually set since webR only checks the [`webr_pkg_repos` key](https://github.com/r-wasm/webr/blob/010223433079d1a9ef3eb9bbf73d8eccb38e6adc/packages/webr/R/install.R#L23); however, other R functions like `available.packages()`
+check the `repos` parameter.
+:::
+
 Alternatively, the `repos` can be specified each time:
 
 ```r