Deploying to gh-pages from @ 8b270f6 🚀

browse/packages.html

@@ -379,7 +379,7 @@ <h2 data-number="5.4" class="anchored" data-anchor-id="all-the-documentation"><s
 </figure>
 </div>
 <p><img src="../img/pkg-manual.png" class="img-fluid" data-group="pkg" alt="Manual of the sf package, displaying a list of all functions in the package, hyperlinked."> <img src="../img/pkg-function-doc.png" class="img-fluid" data-group="pkg" alt="Documentation of one function of the sf package."></p>
-<p>Most R packages have 3 forms of documentation: a README file, a reference manual (help pages), and a number of articles (vignettes). These articles are often a good place to get started, and are listed on the package homepage right under the descriptives. From here you can view both the rendered html/pdf document, as well as the rmarkdown source file used to (re)produce the article.</p>
+<p>Most R packages have 3 forms of documentation: a README file, a reference manual (help pages), and a number of articles (including vignettes). These articles are often a good place to get started, and are listed on the package homepage right under the descriptives. From here you can view both the rendered html/pdf document, as well as the rmarkdown source file used to (re)produce the article.</p>
 <p>Further down the page you can see the content from the package README. Most packages these days include a README.md file which can nicely be rendered into HTML.</p>
 <p>After the README follows a section named “reference manual” containing a table with all the help pages. These link to the respective chapters in the html reference manual, which provide the most extensive documentation for each function in the package, including descriptions, parameters, examples, etc.</p>
 <section id="cran.dev-shortlinks" class="level3" data-number="5.4.1">

search.json

@@ -124,7 +124,7 @@
     "href": "browse/packages.html#all-the-documentation",
     "title": "5  Individual package information",
     "section": "5.4 All the documentation",
-    "text": "5.4 All the documentation\nR-universe renders and presents all available documentation to help you start using packages quickly.\n\n\n\nREADME of the sf package\n\n\n \nMost R packages have 3 forms of documentation: a README file, a reference manual (help pages), and a number of articles (vignettes). These articles are often a good place to get started, and are listed on the package homepage right under the descriptives. From here you can view both the rendered html/pdf document, as well as the rmarkdown source file used to (re)produce the article.\nFurther down the page you can see the content from the package README. Most packages these days include a README.md file which can nicely be rendered into HTML.\nAfter the README follows a section named “reference manual” containing a table with all the help pages. These link to the respective chapters in the html reference manual, which provide the most extensive documentation for each function in the package, including descriptions, parameters, examples, etc.\n\n5.4.1 cran.dev shortlinks\nOn R-universe you can find package repositories from many different organizations and maintainers. But sometimes you just want to lookup a particular CRAN package, without knowing the developer. The cran.dev shortlink service lets you navigate or link directly to the R-universe homepage and docs of any established CRAN package.\nThe root domain https://cran.dev/{package} redirects to the primary homepage for a package:\n\nhttps://cran.dev/magick\nhttps://cran.dev/Matrix\nhttps://cran.dev/ggplot2\n\nThe subdomain https://docs.cran.dev/{package} redirects to package manual page:\n\nhttps://docs.cran.dev/targets\nhttps://docs.cran.dev/MASS\nhttps://docs.cran.dev/Rcpp\n\nFinally the subdomain https://api.cran.dev/{package} does not redirect, but returns a JSON blob with links to the package versions and resources. For example:\n\nhttps://api.cran.dev/gert\n\nThis shows the package page and maintainer for the gert package, and information on both the current CRAN release and development versions. Right now it returns:\n{\n  \"package\": \"gert\",\n  \"maintainer\": \"Jeroen Ooms <[email protected]>\",\n  \"home\": \"https://ropensci.r-universe.dev/gert\",\n  \"release\": {\n    \"version\": \"1.9.2\",\n    \"date\": \"2023-06-30T08:43:26.000Z\",\n    \"source\": \"https://github.com/cran/gert\",\n    \"repository\": \"https://cloud.r-project.org\",\n    \"docs\": \"https://cran.r-universe.dev/gert/doc/manual.html\",\n    \"api\": \"https://cran.r-universe.dev/api/packages/gert\"\n  },\n  \"devel\": {\n    \"version\": \"1.9000\",\n    \"date\": \"2023-07-20T11:08:09.000Z\",\n    \"source\": \"https://github.com/r-lib/gert\",\n    \"repository\": \"https://ropensci.r-universe.dev\",\n    \"docs\": \"https://ropensci.r-universe.dev/gert/doc/manual.html\",\n    \"api\": \"https://ropensci.r-universe.dev/api/packages/gert\"\n  }\n}\nWe can see the release and devel version of this package, with links to the respective sources, cranlike repository, manual, and package metadata.\nFrom the above it can be seen that the gert R-universe page is https://ropensci.r-universe.dev/gert and the R-universe \"repository\" from where to install the devel version of gert:\n# install 'devel' gert\ninstall.packages(\"gert\", repos = \"https://ropensci.r-universe.dev\")\nThe \"api\" field shows the JSON url with all the information and metadata about this package:\n# Everything there is to know about devel gert\ngert <- jsonlite::fromJSON('https://ropensci.r-universe.dev/api/packages/gert')\nNote that not all packages have a devel version available. CRAN packages that are not found on GitHub or GitLab or R-forge only have a release version, for example: https://api.cran.dev/MASS",
+    "text": "5.4 All the documentation\nR-universe renders and presents all available documentation to help you start using packages quickly.\n\n\n\nREADME of the sf package\n\n\n \nMost R packages have 3 forms of documentation: a README file, a reference manual (help pages), and a number of articles (including vignettes). These articles are often a good place to get started, and are listed on the package homepage right under the descriptives. From here you can view both the rendered html/pdf document, as well as the rmarkdown source file used to (re)produce the article.\nFurther down the page you can see the content from the package README. Most packages these days include a README.md file which can nicely be rendered into HTML.\nAfter the README follows a section named “reference manual” containing a table with all the help pages. These link to the respective chapters in the html reference manual, which provide the most extensive documentation for each function in the package, including descriptions, parameters, examples, etc.\n\n5.4.1 cran.dev shortlinks\nOn R-universe you can find package repositories from many different organizations and maintainers. But sometimes you just want to lookup a particular CRAN package, without knowing the developer. The cran.dev shortlink service lets you navigate or link directly to the R-universe homepage and docs of any established CRAN package.\nThe root domain https://cran.dev/{package} redirects to the primary homepage for a package:\n\nhttps://cran.dev/magick\nhttps://cran.dev/Matrix\nhttps://cran.dev/ggplot2\n\nThe subdomain https://docs.cran.dev/{package} redirects to package manual page:\n\nhttps://docs.cran.dev/targets\nhttps://docs.cran.dev/MASS\nhttps://docs.cran.dev/Rcpp\n\nFinally the subdomain https://api.cran.dev/{package} does not redirect, but returns a JSON blob with links to the package versions and resources. For example:\n\nhttps://api.cran.dev/gert\n\nThis shows the package page and maintainer for the gert package, and information on both the current CRAN release and development versions. Right now it returns:\n{\n  \"package\": \"gert\",\n  \"maintainer\": \"Jeroen Ooms <[email protected]>\",\n  \"home\": \"https://ropensci.r-universe.dev/gert\",\n  \"release\": {\n    \"version\": \"1.9.2\",\n    \"date\": \"2023-06-30T08:43:26.000Z\",\n    \"source\": \"https://github.com/cran/gert\",\n    \"repository\": \"https://cloud.r-project.org\",\n    \"docs\": \"https://cran.r-universe.dev/gert/doc/manual.html\",\n    \"api\": \"https://cran.r-universe.dev/api/packages/gert\"\n  },\n  \"devel\": {\n    \"version\": \"1.9000\",\n    \"date\": \"2023-07-20T11:08:09.000Z\",\n    \"source\": \"https://github.com/r-lib/gert\",\n    \"repository\": \"https://ropensci.r-universe.dev\",\n    \"docs\": \"https://ropensci.r-universe.dev/gert/doc/manual.html\",\n    \"api\": \"https://ropensci.r-universe.dev/api/packages/gert\"\n  }\n}\nWe can see the release and devel version of this package, with links to the respective sources, cranlike repository, manual, and package metadata.\nFrom the above it can be seen that the gert R-universe page is https://ropensci.r-universe.dev/gert and the R-universe \"repository\" from where to install the devel version of gert:\n# install 'devel' gert\ninstall.packages(\"gert\", repos = \"https://ropensci.r-universe.dev\")\nThe \"api\" field shows the JSON url with all the information and metadata about this package:\n# Everything there is to know about devel gert\ngert <- jsonlite::fromJSON('https://ropensci.r-universe.dev/api/packages/gert')\nNote that not all packages have a devel version available. CRAN packages that are not found on GitHub or GitLab or R-forge only have a release version, for example: https://api.cran.dev/MASS",
     "crumbs": [
       "Browse",
       "<span class='chapter-number'>5</span>  <span class='chapter-title'>Individual package information</span>"

sitemap.xml

@@ -2,58 +2,58 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
     <loc>https://docs.r-universe.dev/index.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/browse/get-started.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/browse/search.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/browse/universes.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/browse/packages.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/browse/api.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/browse/rss-feeds.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/install/binaries.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/install/reproducibility.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/publish/get-started.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/publish/set-up.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/publish/metadata.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/publish/debug-build.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
   <url>
     <loc>https://docs.r-universe.dev/publish/other-networks.html</loc>
-    <lastmod>2024-12-09T08:26:51.000Z</lastmod>
+    <lastmod>2024-12-09T08:33:53.000Z</lastmod>
   </url>
 </urlset>