Skip to content

Commit d35952a

Browse files
committed
Updated the website
1 parent 4f3762b commit d35952a

File tree

88 files changed

+1290
-962
lines changed

Some content is hidden

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

88 files changed

+1290
-962
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,13 @@ Not using external libraries brings a number of advantages:
339339
- Avoid wasting time, memory and computing resources for translating
340340
between language structures.
341341
- Ensure consistent behaviour with the rest of ‘R’.
342+
- Access to CRAN’s quality control (no comparable quality control
343+
organization exists for most other programming languages).
344+
345+
See the [Other
346+
Packages](https://tony-aw.github.io/broadcast/about/d_other_pkgs.html)
347+
page for more details on the above points regarding the advantages of
348+
minimizing dependencies.
342349

343350

344351

README.qmd

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,9 @@ Not using external libraries brings a number of advantages:
251251
- Avoid dependency hell.
252252
- Avoid wasting time, memory and computing resources for translating between language structures.
253253
- Ensure consistent behaviour with the rest of 'R'.
254+
- Access to CRAN's quality control (no comparable quality control organization exists for most other programming languages).
255+
256+
See the [Other Packages](https://tony-aw.github.io/broadcast/about/d_other_pkgs.html) page for more details on the above points regarding the advantages of minimizing dependencies.
254257

255258

256259

docs/about/a_acknowledgements.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
<li class="sidebar-item">
147147
<div class="sidebar-item-container">
148148
<a href="../about/d_other_pkgs.html" class="sidebar-item-text sidebar-link">
149-
<span class="menu-text">Other packages</span></a>
149+
<span class="menu-text">Other Packages</span></a>
150150
</div>
151151
</li>
152152
<li class="sidebar-item">

docs/about/b_NEWS.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
<li class="sidebar-item">
147147
<div class="sidebar-item-container">
148148
<a href="../about/d_other_pkgs.html" class="sidebar-item-text sidebar-link">
149-
<span class="menu-text">Other packages</span></a>
149+
<span class="menu-text">Other Packages</span></a>
150150
</div>
151151
</li>
152152
<li class="sidebar-item">

docs/about/c_LICENSE.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
<li class="sidebar-item">
147147
<div class="sidebar-item-container">
148148
<a href="../about/d_other_pkgs.html" class="sidebar-item-text sidebar-link">
149-
<span class="menu-text">Other packages</span></a>
149+
<span class="menu-text">Other Packages</span></a>
150150
</div>
151151
</li>
152152
<li class="sidebar-item">

docs/about/d_other_pkgs.html

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
88

99

10-
<title>package broadcast - Other packages</title>
10+
<title>package broadcast - Other Packages</title>
1111
<style>
1212
code{white-space: pre-wrap;}
1313
span.smallcaps{font-variant: small-caps;}
@@ -110,7 +110,7 @@
110110
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
111111
<i class="bi bi-layout-text-sidebar-reverse"></i>
112112
</button>
113-
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../about/d_other_pkgs.html">Other packages</a></li></ol></nav>
113+
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../about/d_other_pkgs.html">Other Packages</a></li></ol></nav>
114114
<a class="flex-grow-1" role="button" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
115115
</a>
116116
</div>
@@ -146,7 +146,7 @@
146146
<li class="sidebar-item">
147147
<div class="sidebar-item-container">
148148
<a href="../about/d_other_pkgs.html" class="sidebar-item-text sidebar-link active">
149-
<span class="menu-text">Other packages</span></a>
149+
<span class="menu-text">Other Packages</span></a>
150150
</div>
151151
</li>
152152
<li class="sidebar-item">
@@ -178,7 +178,7 @@ <h2 id="toc-title">On this page</h2>
178178

179179
<ul>
180180
<li><a href="#alternatives-to-broadcast" id="toc-alternatives-to-broadcast" class="nav-link active" data-scroll-target="#alternatives-to-broadcast">Alternatives to ‘broadcast’</a></li>
181-
<li><a href="#the-tinyverse" id="toc-the-tinyverse" class="nav-link" data-scroll-target="#the-tinyverse">The tinyverse</a></li>
181+
<li><a href="#the-tinyverse" id="toc-the-tinyverse" class="nav-link" data-scroll-target="#the-tinyverse">The tinyverse</a></li>
182182
</ul>
183183
<div class="toc-actions"><div><i class="bi bi-github"></i></div><div class="action-links"><p><a href="https://github.com/tony-aw/broadcast/issues/new" class="toc-action">Report an issue</a></p></div></div></nav>
184184
</div>
@@ -187,7 +187,7 @@ <h2 id="toc-title">On this page</h2>
187187

188188
<header id="title-block-header" class="quarto-title-block default">
189189
<div class="quarto-title">
190-
<h1 class="title">Other packages</h1>
190+
<h1 class="title">Other Packages</h1>
191191
</div>
192192

193193

@@ -213,12 +213,13 @@ <h1>Alternatives to ‘broadcast’</h1>
213213
<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>
214214
<li><strong>Inconsistent behaviour</strong>: Using libraries from other languages also means one cannot always guarantee consistent behaviour for some operations.<br>
215215
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>
216+
<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>
216217
</ul>
217218
<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>
218219
<p>&nbsp;</p>
219220
</section>
220221
<section id="the-tinyverse" class="level1">
221-
<h1>The tinyverse</h1>
222+
<h1>The tinyverse</h1>
222223
<p>The ‘broadcast’ package adheres to the ‘tinyverse’ philosophy (not to be confused with the ‘tidyverse’), which is the programming philosophy to primarily minimize dependencies. ‘broadcast’ also belongs to the <a href="https://github.com/fastverse/fastverse">fastverse</a>, which is a collection of packages aimed at keep code fast and efficient.</p>
223224
<p>Packages that belong to the ‘fastverse’ can be found listed on the dedicated GitHub page:<br>
224225
<a href="https://github.com/fastverse/fastverse">https://github.com/fastverse/fastverse</a>.</p>

docs/about/e_benchmarks_numpy.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@
199199
<li class="sidebar-item">
200200
<div class="sidebar-item-container">
201201
<a href="../about/d_other_pkgs.html" class="sidebar-item-text sidebar-link">
202-
<span class="menu-text">Other packages</span></a>
202+
<span class="menu-text">Other Packages</span></a>
203203
</div>
204204
</li>
205205
<li class="sidebar-item">
@@ -427,6 +427,8 @@ <h1>Results</h1>
427427
<h1>Conclusion &amp; Discussion</h1>
428428
<p>It appears that ‘broadcast’ is slightly faster than ‘Numpy’, though the differences in the computation times between ‘broadcast’ and ‘Numpy’ are rather small. It seems reasonable to conclude that, in general, ‘broadcast’ and ‘Numpy’ have somewhat similar speeds. It can also be observed that ‘broadcast’ has a bit more spread/variation in its computation time than ‘Numpy’.</p>
429429
<p>&nbsp;</p>
430+
<p>The benchmarks shown here involved rather large arrays (90 to 100 million elements). These benchmarks thus focussed on the core computation time, and not so much on the overhead involved.</p>
431+
<p>&nbsp;</p>
430432
<p>As stated earlier, comparing benchmarks between <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> and ‘Python’ should be taken with a grain of salt. I am open for suggestions on how to improve the computation time comparisons between ‘broadcast’ and ‘Numpy’, and make them more fair (so feel free to post suggestions on the GitHub Discussions page).</p>
431433
<p>&nbsp;</p>
432434
</section>

docs/about/f_benchmarks_other.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@
180180
<li class="sidebar-item">
181181
<div class="sidebar-item-container">
182182
<a href="../about/d_other_pkgs.html" class="sidebar-item-text sidebar-link">
183-
<span class="menu-text">Other packages</span></a>
183+
<span class="menu-text">Other Packages</span></a>
184184
</div>
185185
</li>
186186
<li class="sidebar-item">

docs/about/g_unit_test_covr.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@
180180
<li class="sidebar-item">
181181
<div class="sidebar-item-container">
182182
<a href="../about/d_other_pkgs.html" class="sidebar-item-text sidebar-link">
183-
<span class="menu-text">Other packages</span></a>
183+
<span class="menu-text">Other Packages</span></a>
184184
</div>
185185
</li>
186186
<li class="sidebar-item">

docs/index.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,9 @@ <h2 class="anchored" data-anchor-id="why-use-broadcast">Why use ‘broadcast’<
373373
<li>Avoid dependency hell.</li>
374374
<li>Avoid wasting time, memory and computing resources for translating between language structures.</li>
375375
<li>Ensure consistent behaviour with the rest 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>.</li>
376+
<li>Access to CRAN’s quality control (no comparable quality control organization exists for most other programming languages).</li>
376377
</ul>
378+
<p>See the <a href="https://tony-aw.github.io/broadcast/about/d_other_pkgs.html">Other Packages</a> page for more details on the above points regarding the advantages of minimizing dependencies.</p>
377379
<p>&nbsp;</p>
378380
<p><strong>Tested</strong></p>
379381
<p>The ‘broadcast’ package is frequently checked using a large suite of unit tests via the <a href="https://github.com/markvanderloo/tinytest">tinytest</a> package. These tests have a <a href="https://tony-aw.github.io/broadcast/about/g_unit_test_covr.html">coverage</a> of over 90%. So the chance of a function from this package breaking completely is relatively low.</p>

0 commit comments

Comments
 (0)