Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
venpopov committed Mar 26, 2024
1 parent 262deca commit be767b8
Show file tree
Hide file tree
Showing 6 changed files with 657 additions and 464 deletions.
297 changes: 147 additions & 150 deletions dev/dev-notes/add-new-model.html

Large diffs are not rendered by default.

173 changes: 100 additions & 73 deletions dev/dev-notes/bmm-architecture.html

Large diffs are not rendered by default.

619 changes: 389 additions & 230 deletions dev/dev-notes/example-model.html

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion dev/dev-notes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,9 @@ <h1 class="title">BMM Developer Notes</h1>

<section id="overview" class="level1 unnumbered">
<h1 class="unnumbered">Overview</h1>
<p>This article aims to help developers contribute new models to bmm. It is a work in progress and will be updated as the package evolves. It explains how to set-up your system for package development, the structure of the package, and the workflow for contributing new models to the package.</p>
<p><em>Last update: 26.03.2024</em></p>
<p>This guide aims to help developers contribute new models to bmm. It is a work in progress and will be updated as the package evolves. It explains how to set-up your system for package development, the structure of the package, and the workflow for contributing new models to the package.</p>
<p>The current guide is up to date with <strong>bmm v0.5.0</strong> and it might not yet reflect changes implemented afterwards. If you run into problems, don’’t hesitate to <a href="https://github.com/venpopov/bmm/issues">open an issue on github</a>.</p>
<p>We follow a <a href="https://jeffkreeftmeijer.com/git-flow/">github flow workflow</a>. The repository contains two main branches:</p>
<ul>
<li><p>Master (contains the latest released stable version of the <code>bmm</code> package)</p></li>
Expand Down
23 changes: 15 additions & 8 deletions dev/dev-notes/search.json

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions dev/dev-notes/setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,9 @@ <h2 data-number="1.2" class="anchored" data-anchor-id="package-development-via-r
<ol type="1">
<li><p>Make sure you have the devtools package and a few others installed and loaded</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1"></a><span class="fu">install.packages</span>(<span class="fu">c</span>(<span class="st">"devtools"</span>, <span class="st">"roxygen2"</span>, <span class="st">"testthat"</span>, <span class="st">"knitr"</span>))</span>
<span id="cb1-2"><a href="#cb1-2"></a><span class="fu">library</span>(devtools)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>To avoid having to load the package every time, you can add the following code to your <code>.Rprofile</code> file</p>
<span id="cb1-2"><a href="#cb1-2"></a><span class="fu">library</span>(devtools)</span>
<span id="cb1-3"><a href="#cb1-3"></a><span class="fu">install_dev_deps</span>()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>To avoid having to load the <strong>devtools</strong> package every time, you can add the following code to your <code>.Rprofile</code> file</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1"></a><span class="cf">if</span> (<span class="fu">interactive</span>()) {</span>
<span id="cb2-2"><a href="#cb2-2"></a> <span class="fu">suppressMessages</span>(<span class="fu">require</span>(devtools))</span>
<span id="cb2-3"><a href="#cb2-3"></a>}</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
Expand Down

0 comments on commit be767b8

Please sign in to comment.