Skip to content

Commit 97f6cd5

Browse files
committed
Updated the website
1 parent 04b4d00 commit 97f6cd5

File tree

96 files changed

+1042
-1040
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+1042
-1040
lines changed

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -281,9 +281,6 @@ of the variables is.
281281
The **Quick-Start Guide** can be found
282282
[here](https://tony-aw.github.io/broadcast/vignettes/b_quickstart.html).
283283

284-
Some **Practical Applications** of the ‘broadcast’ package can be found
285-
[here](https://tony-aw.github.io/broadcast/vignettes/practical_applications.html).
286-
287284

288285

289286
## 🤷🏽Why use ‘broadcast’
@@ -350,7 +347,7 @@ The ‘broadcast’ package is frequently checked using a large suite of
350347
unit tests via the [tinytest](https://github.com/markvanderloo/tinytest)
351348
package. These tests have a
352349
[coverage](https://tony-aw.github.io/broadcast/about/g_unit_test_covr.html)
353-
of over 90%. So the chance of a function from this package breaking
350+
of over 95%. So the chance of a function from this package breaking
354351
completely is relatively low.
355352

356353
‘broadcast’ is still relatively new package, however, so (small) bugs

README.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ See the [Other Packages](https://tony-aw.github.io/broadcast/about/d_other_pkgs.
257257

258258
**Tested**
259259

260-
The 'broadcast' package is frequently checked using a large suite of unit tests via the [tinytest](https://github.com/markvanderloo/tinytest) package. These tests have a [coverage](https://tony-aw.github.io/broadcast/about/g_unit_test_covr.html) of over 90%. So the chance of a function from this package breaking completely is relatively low.
260+
The 'broadcast' package is frequently checked using a large suite of unit tests via the [tinytest](https://github.com/markvanderloo/tinytest) package. These tests have a [coverage](https://tony-aw.github.io/broadcast/about/g_unit_test_covr.html) of over 95%. So the chance of a function from this package breaking completely is relatively low.
261261

262262
'broadcast' is still relatively new package, however, so (small) bugs are still very much possible. I encourage users who find bugs to report them promptly to the [issues](https://github.com/tony-aw/broadcast/issues) tab on the GitHub page, and I will fix them as soon as time permits.
263263

docs/about/d_other_pkgs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ <h1>Alternatives to ‘broadcast’</h1>
219219
<li><strong>Wasteful translations</strong>: Using libraries from other languages, such as ‘xtensor’ (‘C++’) or ‘Numpy’ (‘Python’) means that - at some point - one needs to convert between the structure of <svg aria-hidden="true" role="img" viewbox="0 0 581 512" style="height:1em;width:1.13em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M581 226.6C581 119.1 450.9 32 290.5 32S0 119.1 0 226.6C0 322.4 103.3 402 239.4 418.1V480h99.1v-61.5c24.3-2.7 47.6-7.4 69.4-13.9L448 480h112l-67.4-113.7c54.5-35.4 88.4-84.9 88.4-139.7zm-466.8 14.5c0-73.5 98.9-133 220.8-133s211.9 40.7 211.9 133c0 50.1-26.5 85-70.3 106.4-2.4-1.6-4.7-2.9-6.4-3.7-10.2-5.2-27.8-10.5-27.8-10.5s86.6-6.4 86.6-92.7-90.6-87.9-90.6-87.9h-199V361c-74.1-21.5-125.2-67.1-125.2-119.9zm225.1 38.3v-55.6c57.8 0 87.8-6.8 87.8 27.3 0 36.5-38.2 28.3-87.8 28.3zm-.9 72.5H365c10.8 0 18.9 11.7 24 19.2-16.1 1.9-33 2.8-50.6 2.9v-22.1z"></path></svg> to that of the other language, and vice-versa, which wastes precious time, memory, and power.</li>
220220
<li><strong>Inconsistent behaviour</strong>: Using libraries from other languages also means one cannot always guarantee consistent behaviour for some operations.<br>
221221
For example: both ‘Numpy’ and ‘xtensor’ have only limited support for missing values, whereas <svg aria-hidden="true" role="img" viewbox="0 0 581 512" style="height:1em;width:1.13em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M581 226.6C581 119.1 450.9 32 290.5 32S0 119.1 0 226.6C0 322.4 103.3 402 239.4 418.1V480h99.1v-61.5c24.3-2.7 47.6-7.4 69.4-13.9L448 480h112l-67.4-113.7c54.5-35.4 88.4-84.9 88.4-139.7zm-466.8 14.5c0-73.5 98.9-133 220.8-133s211.9 40.7 211.9 133c0 50.1-26.5 85-70.3 106.4-2.4-1.6-4.7-2.9-6.4-3.7-10.2-5.2-27.8-10.5-27.8-10.5s86.6-6.4 86.6-92.7-90.6-87.9-90.6-87.9h-199V361c-74.1-21.5-125.2-67.1-125.2-119.9zm225.1 38.3v-55.6c57.8 0 87.8-6.8 87.8 27.3 0 36.5-38.2 28.3-87.8 28.3zm-.9 72.5H365c10.8 0 18.9 11.7 24 19.2-16.1 1.9-33 2.8-50.6 2.9v-22.1z"></path></svg> supports missing values for both atomic and recursive array/vector types (except type of ‘Raw’).</li>
222-
<li><strong>Access to CRAN’s quality control</strong>: ‘R’ is unique in that it has access to CRAN’s quality control; most other languages (including Python) don’t have a real comparable organization like CRAN.</li>
222+
<li><strong>Access to CRAN’s quality control</strong>: <svg aria-hidden="true" role="img" viewbox="0 0 581 512" style="height:1em;width:1.13em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M581 226.6C581 119.1 450.9 32 290.5 32S0 119.1 0 226.6C0 322.4 103.3 402 239.4 418.1V480h99.1v-61.5c24.3-2.7 47.6-7.4 69.4-13.9L448 480h112l-67.4-113.7c54.5-35.4 88.4-84.9 88.4-139.7zm-466.8 14.5c0-73.5 98.9-133 220.8-133s211.9 40.7 211.9 133c0 50.1-26.5 85-70.3 106.4-2.4-1.6-4.7-2.9-6.4-3.7-10.2-5.2-27.8-10.5-27.8-10.5s86.6-6.4 86.6-92.7-90.6-87.9-90.6-87.9h-199V361c-74.1-21.5-125.2-67.1-125.2-119.9zm225.1 38.3v-55.6c57.8 0 87.8-6.8 87.8 27.3 0 36.5-38.2 28.3-87.8 28.3zm-.9 72.5H365c10.8 0 18.9 11.7 24 19.2-16.1 1.9-33 2.8-50.6 2.9v-22.1z"></path></svg> is unique in that it has access to CRAN’s quality control; most other languages (including Python) don’t have a real comparable organization like CRAN.</li>
223223
</ul>
224224
<p>Since the ‘broadcast’ package does not rely on any external library, other than linking to ‘Rcpp’, ‘broadcast’ avoids all of the above issues.</p>
225225
<p>&nbsp;</p>

docs/about/e_benchmarks_numpy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ <h2 class="anchored" data-anchor-id="keeping-comparisons-somewhat-fair">Keeping
331331
</section>
332332
<section id="resources-and-code" class="level2">
333333
<h2 class="anchored" data-anchor-id="resources-and-code">Resources and Code</h2>
334-
<p>The code used to run the benchmarks can be found at the bottom of this page. <svg aria-hidden="true" role="img" viewbox="0 0 581 512" style="height:1em;width:1.13em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M581 226.6C581 119.1 450.9 32 290.5 32S0 119.1 0 226.6C0 322.4 103.3 402 239.4 418.1V480h99.1v-61.5c24.3-2.7 47.6-7.4 69.4-13.9L448 480h112l-67.4-113.7c54.5-35.4 88.4-84.9 88.4-139.7zm-466.8 14.5c0-73.5 98.9-133 220.8-133s211.9 40.7 211.9 133c0 50.1-26.5 85-70.3 106.4-2.4-1.6-4.7-2.9-6.4-3.7-10.2-5.2-27.8-10.5-27.8-10.5s86.6-6.4 86.6-92.7-90.6-87.9-90.6-87.9h-199V361c-74.1-21.5-125.2-67.1-125.2-119.9zm225.1 38.3v-55.6c57.8 0 87.8-6.8 87.8 27.3 0 36.5-38.2 28.3-87.8 28.3zm-.9 72.5H365c10.8 0 18.9 11.7 24 19.2-16.1 1.9-33 2.8-50.6 2.9v-22.1z"></path></svg> version <code>4.5.1</code> <span class="citation" data-cites="r">(<a href="#ref-r" role="doc-biblioref">R Core Team 2024</a>)</span> with the latest version (<code>0.1.7.5</code>) of ‘broadcast’ was used to run the <svg aria-hidden="true" role="img" viewbox="0 0 581 512" style="height:1em;width:1.13em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M581 226.6C581 119.1 450.9 32 290.5 32S0 119.1 0 226.6C0 322.4 103.3 402 239.4 418.1V480h99.1v-61.5c24.3-2.7 47.6-7.4 69.4-13.9L448 480h112l-67.4-113.7c54.5-35.4 88.4-84.9 88.4-139.7zm-466.8 14.5c0-73.5 98.9-133 220.8-133s211.9 40.7 211.9 133c0 50.1-26.5 85-70.3 106.4-2.4-1.6-4.7-2.9-6.4-3.7-10.2-5.2-27.8-10.5-27.8-10.5s86.6-6.4 86.6-92.7-90.6-87.9-90.6-87.9h-199V361c-74.1-21.5-125.2-67.1-125.2-119.9zm225.1 38.3v-55.6c57.8 0 87.8-6.8 87.8 27.3 0 36.5-38.2 28.3-87.8 28.3zm-.9 72.5H365c10.8 0 18.9 11.7 24 19.2-16.1 1.9-33 2.8-50.6 2.9v-22.1z"></path></svg> code. ‘Python’ version <code>3.12.0</code> <span class="citation" data-cites="python">(<a href="#ref-python" role="doc-biblioref">Van Rossum and Drake 2009</a>)</span> with ‘Numpy’ version <code>2.4.2</code> <span class="citation" data-cites="numpy">(<a href="#ref-numpy" role="doc-biblioref">Harris et al. 2020</a>)</span> was used to run the ‘Python’ code.</p>
334+
<p>The code used to run the benchmarks can be found at the bottom of this page. <svg aria-hidden="true" role="img" viewbox="0 0 581 512" style="height:1em;width:1.13em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M581 226.6C581 119.1 450.9 32 290.5 32S0 119.1 0 226.6C0 322.4 103.3 402 239.4 418.1V480h99.1v-61.5c24.3-2.7 47.6-7.4 69.4-13.9L448 480h112l-67.4-113.7c54.5-35.4 88.4-84.9 88.4-139.7zm-466.8 14.5c0-73.5 98.9-133 220.8-133s211.9 40.7 211.9 133c0 50.1-26.5 85-70.3 106.4-2.4-1.6-4.7-2.9-6.4-3.7-10.2-5.2-27.8-10.5-27.8-10.5s86.6-6.4 86.6-92.7-90.6-87.9-90.6-87.9h-199V361c-74.1-21.5-125.2-67.1-125.2-119.9zm225.1 38.3v-55.6c57.8 0 87.8-6.8 87.8 27.3 0 36.5-38.2 28.3-87.8 28.3zm-.9 72.5H365c10.8 0 18.9 11.7 24 19.2-16.1 1.9-33 2.8-50.6 2.9v-22.1z"></path></svg> version <code>4.5.1</code> <span class="citation" data-cites="r">(<a href="#ref-r" role="doc-biblioref">R Core Team 2024</a>)</span> with the latest version (<code>0.1.8</code>) of ‘broadcast’ was used to run the <svg aria-hidden="true" role="img" viewbox="0 0 581 512" style="height:1em;width:1.13em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M581 226.6C581 119.1 450.9 32 290.5 32S0 119.1 0 226.6C0 322.4 103.3 402 239.4 418.1V480h99.1v-61.5c24.3-2.7 47.6-7.4 69.4-13.9L448 480h112l-67.4-113.7c54.5-35.4 88.4-84.9 88.4-139.7zm-466.8 14.5c0-73.5 98.9-133 220.8-133s211.9 40.7 211.9 133c0 50.1-26.5 85-70.3 106.4-2.4-1.6-4.7-2.9-6.4-3.7-10.2-5.2-27.8-10.5-27.8-10.5s86.6-6.4 86.6-92.7-90.6-87.9-90.6-87.9h-199V361c-74.1-21.5-125.2-67.1-125.2-119.9zm225.1 38.3v-55.6c57.8 0 87.8-6.8 87.8 27.3 0 36.5-38.2 28.3-87.8 28.3zm-.9 72.5H365c10.8 0 18.9 11.7 24 19.2-16.1 1.9-33 2.8-50.6 2.9v-22.1z"></path></svg> code. ‘Python’ version <code>3.12.0</code> <span class="citation" data-cites="python">(<a href="#ref-python" role="doc-biblioref">Van Rossum and Drake 2009</a>)</span> with ‘Numpy’ version <code>2.4.2</code> <span class="citation" data-cites="numpy">(<a href="#ref-numpy" role="doc-biblioref">Harris et al. 2020</a>)</span> was used to run the ‘Python’ code.</p>
335335
<p>The <svg aria-hidden="true" role="img" viewbox="0 0 581 512" style="height:1em;width:1.13em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M581 226.6C581 119.1 450.9 32 290.5 32S0 119.1 0 226.6C0 322.4 103.3 402 239.4 418.1V480h99.1v-61.5c24.3-2.7 47.6-7.4 69.4-13.9L448 480h112l-67.4-113.7c54.5-35.4 88.4-84.9 88.4-139.7zm-466.8 14.5c0-73.5 98.9-133 220.8-133s211.9 40.7 211.9 133c0 50.1-26.5 85-70.3 106.4-2.4-1.6-4.7-2.9-6.4-3.7-10.2-5.2-27.8-10.5-27.8-10.5s86.6-6.4 86.6-92.7-90.6-87.9-90.6-87.9h-199V361c-74.1-21.5-125.2-67.1-125.2-119.9zm225.1 38.3v-55.6c57.8 0 87.8-6.8 87.8 27.3 0 36.5-38.2 28.3-87.8 28.3zm-.9 72.5H365c10.8 0 18.9 11.7 24 19.2-16.1 1.9-33 2.8-50.6 2.9v-22.1z"></path></svg> code was sourced from ‘RStudio’ version <code>2025.09.1</code> <span class="citation" data-cites="rstudio">(<a href="#ref-rstudio" role="doc-biblioref">Posit team 2025</a>)</span> using <code>source()</code>, from a freshly started computer. The ‘Python’ code was run via ‘Jupyter’ Notebook <span class="citation" data-cites="jupyter">(<a href="#ref-jupyter" role="doc-biblioref">Granger and Pérez 2021</a>)</span>, also from a freshly started computer.</p>
336336
<p>The <code>bench::mark()</code> function from the ‘bench’ <span class="citation" data-cites="bench">(<a href="#ref-bench" role="doc-biblioref">Hester and Vaughan 2023</a>)</span> package was used for measuring the execution time in <svg aria-hidden="true" role="img" viewbox="0 0 581 512" style="height:1em;width:1.13em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:currentColor;overflow:visible;position:relative;"><path d="M581 226.6C581 119.1 450.9 32 290.5 32S0 119.1 0 226.6C0 322.4 103.3 402 239.4 418.1V480h99.1v-61.5c24.3-2.7 47.6-7.4 69.4-13.9L448 480h112l-67.4-113.7c54.5-35.4 88.4-84.9 88.4-139.7zm-466.8 14.5c0-73.5 98.9-133 220.8-133s211.9 40.7 211.9 133c0 50.1-26.5 85-70.3 106.4-2.4-1.6-4.7-2.9-6.4-3.7-10.2-5.2-27.8-10.5-27.8-10.5s86.6-6.4 86.6-92.7-90.6-87.9-90.6-87.9h-199V361c-74.1-21.5-125.2-67.1-125.2-119.9zm225.1 38.3v-55.6c57.8 0 87.8-6.8 87.8 27.3 0 36.5-38.2 28.3-87.8 28.3zm-.9 72.5H365c10.8 0 18.9 11.7 24 19.2-16.1 1.9-33 2.8-50.6 2.9v-22.1z"></path></svg>, as this package can also be used to check and filter for garbage collector calls.</p>
337337
<p>In ‘Python’, the <code>time.perf_counter()</code> function was used to accurately measure the execution time of an operation. To ensure no time was wasted on printing the result in ‘Python’, the operation <code>a + b</code> was wrapped inside a trivial function without a return statement.</p>

docs/about/g_unit_test_covr.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ <h1 class="title">Unit Test Coverage Report</h1>
202202
</header>
203203

204204
<p>&nbsp;</p>
205-
<p>The unit tests employed by the ‘broadcast’ package have a test coverage of over 90%.<br>
205+
<p>The unit tests employed by the ‘broadcast’ package have a test coverage of over 95%.<br>
206206
For the sake of transparency, the unit tests coverage report, produced by the <a href="https://github.com/r-lib/covr">covr</a> package, is provided here:</p>
207207
<pre><code>broadcast Coverage: 96.55%
208208
R/internal_typefuns.R: 79.66%

0 commit comments

Comments
 (0)