Built site for gh-pages

.nojekyll

@@ -1 +1 @@
-0d13fe1b
+265a323d

search.json

@@ -84,7 +84,7 @@
     "href": "style.html#r",
     "title": "2  Style ",
     "section": "",
-    "text": "2.1.1 Package styler\nThe styler package allows you to interactively format your code according to the tidyverse style guide.\nThe lintr package does automated checks of your code according to the style guide.\n\n\n2.1.2 IDE and Text editor support\nRStudio supports styler via the Addins drop down; see the RStudio User Guide.\nSupport for styler in other editors is provided via the R languageserver:\n\nVSCode: vscode-R\nAtom: atom-ide-r\nSublime Text: R-IDE\nVim/NeoVim: LanguageClient-neovim\n\nSee the R languageserver GitHub repository for more information on using the R languageserver.\n\n\n2.1.3 Command line/Terminal/R\nIn the getwilds/makefiles repo we have an R package Makefile template with three make targets for styling package code: lint_package, style_file, and style_package. With that Makefile in the root of your package you can run lint_package to check for any problems, and run style_file or style_package to fix any problems. You can also just run the R code in those make targets in a terminal or within R.\n\n\n2.1.4 GitHub Actions\nTo get setup with GitHub Actions and lintr and styler, first install lintr if you don’t have it:\nif (!requireNamespace(\"pak\", quietly=TRUE)) {\n  install.packages(\"pak\")\n}\npak::pkg_install(\"lintr\")\nAnd then run:\nlintr::use_lintr()\nTo create a configuration file for lintr. In the file created (.lintr) you can set custom congifuration as needed for your package (see the lintr vignette).\nNext, run:\nusethis::use_github_action(\"lint\")\nwhich creates a file .github/workflows/lint.yaml in your package to run lintr checks on your package. This action only reports problems and does not fix them for you. If you want to have any problems fixed automatically and committed to your main branch, run:\nusethis::use_github_action(\"style\")\nNote that the above action will create commits all with the same message: \"Style code (GHA)\".\nWe think in most cases it makes sense to only use the lint action and not the style action, but you’re free to use either or both.",
+    "text": "2.1.1 Package styler\nThe styler package allows you to interactively format your code according to the tidyverse style guide. In fact, the default style used by the package is called “tidyverse” - following the style they use. That’s what WILDS packages use as it’s good enough until we’d like to tweak things.\nThe lintr package does automated checks of your code according to the style guide.\n\n\n2.1.2 IDE and Text editor support\nRStudio supports styler via the Addins drop down; see the RStudio User Guide.\nSupport for styler in other editors is provided via the R languageserver:\n\nVSCode: vscode-R\nAtom: atom-ide-r\nSublime Text: R-IDE\nVim/NeoVim: LanguageClient-neovim\n\nSee the R languageserver GitHub repository for more information on using the R languageserver.\n\n\n2.1.3 Command line/Terminal/R\nIn the getwilds/makefiles repo we have an R package Makefile template with three make targets for styling package code: lint_package, style_file, and style_package. With that Makefile in the root of your package you can run lint_package to check for any problems, and run style_file or style_package to fix any problems. You can also just run the R code in those make targets in a terminal or within R.\n\n\n2.1.4 GitHub Actions\nTo get setup with GitHub Actions and lintr and styler, first install lintr if you don’t have it:\nif (!requireNamespace(\"pak\", quietly=TRUE)) {\n  install.packages(\"pak\")\n}\npak::pkg_install(\"lintr\")\nAnd then run:\nlintr::use_lintr()\nTo create a configuration file for lintr. In the file created (.lintr) you can set custom congifuration as needed for your package (see the lintr vignette).\nNext, run:\nusethis::use_github_action(\"lint\")\nwhich creates a file .github/workflows/lint.yaml in your package to run lintr checks on your package. This action only reports problems and does not fix them for you. If you want to have any problems fixed automatically and committed to your main branch, run:\nusethis::use_github_action(\"style\")\nNote that the above action will create commits all with the same message: \"Style code (GHA)\".\nWe think in most cases it makes sense to only use the lint action and not the style action, but you’re free to use either or both.\n\n\n2.1.5 Nolint\nSometimes there are valid use cases for suppressing lint checks. For example, if there’s a rule that says line length should be no more than 80 characters, and there’s just no way to comply then you could tell lintr to ignore that line. The lintr Getting Started article has all the details on exclusions.",
     "crumbs": [
       "<span class='chapter-number'>2</span>  <span class='chapter-title'>Style {{< iconify fa6-solid code >}}</span>"
     ]

sitemap.xml

@@ -2,62 +2,62 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
     <loc>https://getwilds.org/guide/index.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.837Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/contributing.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.837Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/style.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.838Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/codereview-dasl.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.836Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/codereview-external.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.836Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/codereview-general.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.836Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/codereview-guidelines.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.836Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/packagedocs.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.838Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/testing.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.838Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/maintenance.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.838Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/wdlconfig.html</loc>
-    <lastmod>2024-09-16T16:29:41.006Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.838Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/docker.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.837Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/conventions.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.837Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/standards.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.838Z</lastmod>
   </url>
   <url>
     <loc>https://getwilds.org/guide/codereview.html</loc>
-    <lastmod>2024-09-16T16:29:41.002Z</lastmod>
+    <lastmod>2024-09-30T13:30:26.837Z</lastmod>
   </url>
 </urlset>

style.html

@@ -263,6 +263,7 @@ <h2 id="toc-title">Table of contents</h2>
   <li><a href="#ide-and-text-editor-support" id="toc-ide-and-text-editor-support" class="nav-link" data-scroll-target="#ide-and-text-editor-support"><span class="header-section-number">2.1.2</span> IDE and Text editor support</a></li>
   <li><a href="#command-lineterminalr" id="toc-command-lineterminalr" class="nav-link" data-scroll-target="#command-lineterminalr"><span class="header-section-number">2.1.3</span> Command line/Terminal/R</a></li>
   <li><a href="#sec-style-actions" id="toc-sec-style-actions" class="nav-link" data-scroll-target="#sec-style-actions"><span class="header-section-number">2.1.4</span> GitHub Actions</a></li>
+  <li><a href="#nolint" id="toc-nolint" class="nav-link" data-scroll-target="#nolint"><span class="header-section-number">2.1.5</span> Nolint</a></li>
   </ul></li>
   <li><a href="#python" id="toc-python" class="nav-link" data-scroll-target="#python"><span class="header-section-number">2.2</span> Python</a>
   <ul class="collapse">
@@ -303,7 +304,7 @@ <h1 class="title d-none d-lg-block"><span id="sec-style" class="quarto-section-i
 <h2 data-number="2.1" class="anchored" data-anchor-id="r"><span class="header-section-number">2.1</span> R</h2>
 <section id="package-styler" class="level3" data-number="2.1.1">
 <h3 data-number="2.1.1" class="anchored" data-anchor-id="package-styler"><span class="header-section-number">2.1.1</span> Package styler</h3>
-<p>The <a href="https://styler.r-lib.org/">styler</a> package allows you to interactively format your code according to the <a href="https://style.tidyverse.org/">tidyverse style guide</a>.</p>
+<p>The <a href="https://styler.r-lib.org/">styler</a> package allows you to interactively format your code according to the <a href="https://style.tidyverse.org/">tidyverse style guide</a>. In fact, the default style used by the package is called “tidyverse” - following the style they use. That’s what WILDS packages use as it’s good enough until we’d like to tweak things.</p>
 <p>The <a href="https://lintr.r-lib.org/">lintr</a> package does automated checks of your code according to the style guide.</p>
 </section>
 <section id="ide-and-text-editor-support" class="level3" data-number="2.1.2">
@@ -339,6 +340,10 @@ <h3 data-number="2.1.4" class="anchored" data-anchor-id="sec-style-actions"><spa
 <p>Note that the above action will create commits all with the same message: <code>"Style code (GHA)"</code>.</p>
 <p>We think in most cases it makes sense to only use the <code>lint</code> action and not the <code>style</code> action, but you’re free to use either or both.</p>
 </section>
+<section id="nolint" class="level3" data-number="2.1.5">
+<h3 data-number="2.1.5" class="anchored" data-anchor-id="nolint"><span class="header-section-number">2.1.5</span> Nolint</h3>
+<p>Sometimes there are valid use cases for suppressing lint checks. For example, if there’s a rule that says line length should be no more than 80 characters, and there’s just no way to comply then you could tell <code>lintr</code> to ignore that line. The lintr <a href="https://lintr.r-lib.org/articles/lintr.html#exclusions">Getting Started article</a> has all the details on exclusions.</p>
+</section>
 </section>
 <section id="python" class="level2" data-number="2.2">
 <h2 data-number="2.2" class="anchored" data-anchor-id="python"><span class="header-section-number">2.2</span> Python</h2>