You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- Generated by pkgdown: do not edit by hand --><htmllang="en-US"><head><metahttp-equiv="Content-Type" content="text/html; charset=UTF-8"><metacharset="utf-8"><metahttp-equiv="X-UA-Compatible" content="IE=edge"><metaname="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Contributing to serocalculator • serocalculator</title><scriptsrc="lightswitch.js"></script><scriptsrc="deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><metaname="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><linkhref="deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><scriptsrc="deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><linkhref="deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><linkhref="deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><scriptsrc="deps/headroom-0.11.0/headroom.min.js"></script><scriptsrc="deps/headroom-0.11.0/jQuery.headroom.min.js"></script><scriptsrc="deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><scriptsrc="deps/clipboard.js-2.0.11/clipboard.min.js"></script><scriptsrc="deps/search-1.0.0/autocomplete.jquery.min.js"></script><scriptsrc="deps/search-1.0.0/fuse.min.js"></script><scriptsrc="deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><scriptsrc="pkgdown.js"></script><metaproperty="og:title" content="Contributing to serocalculator"></head><body>
2
+
<!-- Generated by pkgdown + https://github.com/insightsengineering/r-pkgdown-multiversion -->
<ulclass="dropdown-menu" aria-labelledby="dropdown-articles"><li><aclass="dropdown-item" href="articles/serocalculator.html">Introduction to serocalculator</a></li>
@@ -57,46 +87,59 @@ <h1>Contributing to serocalculator</h1>
57
87
58
88
<p>This outlines how to propose a change to <ahref="https://ucd-serg.github.io/serocalculator/">serocalculator</a>. For a detailed discussion on contributing to this and other tidyverse packages, please see the <ahref="https://rstd.io/tidy-contrib" class="external-link">development contributing guide</a> and our <ahref="https://code-review.tidyverse.org/" class="external-link">code review principles</a>.</p>
<p>You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the <em>source</em> file. This generally means you’ll need to edit <ahref="https://roxygen2.r-lib.org/articles/roxygen2.html" class="external-link">roxygen2 comments</a> in an <code>.R</code>, not a <code>.Rd</code> file. You can find the <code>.R</code> file that generates the <code>.Rd</code> by reading the comment in the first line.</p>
<p>If you want to make a bigger change, it’s a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal <ahref="https://www.tidyverse.org/help/#reprex" class="external-link">reprex</a> (this will also help you write a unit test, if needed). See our guide on <ahref="https://code-review.tidyverse.org/issues/" class="external-link">how to create a great issue</a> for more advice.</p>
<ul><li><p>Fork the package and clone onto your computer. If you haven’t done this before, we recommend using <code>usethis::create_from_github("UCD-SERG/serocalculator", fork = TRUE)</code>.</p></li>
<li><p>Fork the package and clone onto your computer. If you haven’t done this before, we recommend using <code>usethis::create_from_github("UCD-SERG/serocalculator", fork = TRUE)</code>.</p></li>
69
103
<li><p>Install all development dependencies with <code>devtools::install_dev_deps()</code>, and then make sure the package passes R CMD check by running <code>devtools::check()</code>. If R CMD check doesn’t pass cleanly, it’s a good idea to ask for help before continuing.</p></li>
70
104
<li><p>Create a Git branch for your pull request (PR). We recommend using <code>usethis::pr_init("brief-description-of-change")</code>.</p></li>
71
105
<li><p>Make your changes, commit to git, and then create a PR by running <code><ahref="https://usethis.r-lib.org/reference/pull-requests.html" class="external-link">usethis::pr_push()</a></code>, and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain <code>Fixes #issue-number</code>.</p></li>
72
106
<li>
73
107
<p>For user-facing changes, add a bullet to the top of <code>NEWS.md</code> (i.e. just below the first header). Follow the style described in <ahref="https://style.tidyverse.org/news.html" class="external-link uri">https://style.tidyverse.org/news.html</a>.</p>
74
-
<ul><li>Also, please begin commit messages with <code>-</code> when committing user-facing changes that should be included in NEWS.md. We will are testing the use of <ahref="https://github.com/krlmlr/fledge" class="external-link">fledge</a> to automatically update the NEWS.md file.</li>
75
-
</ul></li>
108
+
<ul>
109
+
<li>Also, please begin commit messages with <code>-</code> when committing user-facing changes that should be included in NEWS.md. We will are testing the use of <ahref="https://github.com/krlmlr/fledge" class="external-link">fledge</a> to automatically update the NEWS.md file.</li>
110
+
</ul>
111
+
</li>
76
112
<li><p>GitHub will <ahref="https://github.com/r-lib/actions" class="external-link">automatically check your PR</a> to see if the package is still functional on Mac OS, Windows, and Linux; if not, you will receive an email describing the problems. For help decoding errors, try this resource: <ahref="https://github.com/r-lib/actions?tab=readme-ov-file#where-to-find-help" class="external-link uri">https://github.com/r-lib/actions?tab=readme-ov-file#where-to-find-help</a>.</p></li>
<ul><li><p>New code should follow the tidyverse <ahref="https://style.tidyverse.org" class="external-link">style guide</a>. You can use the <ahref="https://CRAN.R-project.org/package=styler" class="external-link">styler</a> package to apply these styles, but please don’t restyle code that has nothing to do with your PR.</p></li>
<li><p>New code should follow the tidyverse <ahref="https://style.tidyverse.org" class="external-link">style guide</a>. You can use the <ahref="https://CRAN.R-project.org/package=styler" class="external-link">styler</a> package to apply these styles, but please don’t restyle code that has nothing to do with your PR.</p></li>
82
121
<li><p>We use <ahref="https://cran.r-project.org/package=roxygen2" class="external-link">roxygen2</a>, with <ahref="https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html" class="external-link">Markdown syntax</a>, for documentation.</p></li>
83
122
<li><p>We use <ahref="https://cran.r-project.org/package=testthat" class="external-link">testthat</a> for unit tests. Contributions with test cases included are easier to accept.</p></li>
84
-
</ul></div>
123
+
</ul>
124
+
</div>
85
125
</div>
86
126
<divclass="section level2">
87
-
<h2id="code-of-conduct">Code of Conduct<aclass="anchor" aria-label="anchor" href="#code-of-conduct"></a></h2>
127
+
<h2id="code-of-conduct">Code of Conduct<aclass="anchor" aria-label="anchor" href="#code-of-conduct"></a>
128
+
</h2>
88
129
<p>Please note that the serocalculator project is released with a <ahref="CODE_OF_CONDUCT.html">Contributor Code of Conduct</a>. By contributing to this project you agree to abide by its terms.</p>
89
130
</div>
90
131
<divclass="section level2">
91
-
<h2id="guide-to-the-package-structure">Guide to the package structure<aclass="anchor" aria-label="anchor" href="#guide-to-the-package-structure"></a></h2>
132
+
<h2id="guide-to-the-package-structure">Guide to the package structure<aclass="anchor" aria-label="anchor" href="#guide-to-the-package-structure"></a>
133
+
</h2>
92
134
<p>You can use the <ahref="https://lewinfox.com/foodwebr/" class="external-link">foodwebr</a> package to visualize the internal structure of <ahref="https://ucd-serg.github.io/serocalculator/">serocalculator</a>; for example, to see the subfunctions of <code><ahref="reference/sim_pop_data.html">sim_pop_data()</a></code>, you can call:</p>
0 commit comments