-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathweek8-adv-packages.html
860 lines (755 loc) · 35.2 KB
/
week8-adv-packages.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta http-equiv="X-UA-Compatible" content="IE=EDGE" />
<title>Week 8: More R package tips</title>
<script src="site_libs/header-attrs-2.11/header-attrs.js"></script>
<script src="site_libs/jquery-3.6.0/jquery-3.6.0.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="site_libs/bootstrap-3.3.5/css/readable.min.css" rel="stylesheet" />
<script src="site_libs/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/respond.min.js"></script>
<style>h1 {font-size: 34px;}
h1.title {font-size: 38px;}
h2 {font-size: 30px;}
h3 {font-size: 24px;}
h4 {font-size: 18px;}
h5 {font-size: 16px;}
h6 {font-size: 12px;}
code {color: inherit; background-color: rgba(0, 0, 0, 0.04);}
pre:not([class]) { background-color: white }</style>
<script src="site_libs/jqueryui-1.11.4/jquery-ui.min.js"></script>
<link href="site_libs/tocify-1.9.1/jquery.tocify.css" rel="stylesheet" />
<script src="site_libs/tocify-1.9.1/jquery.tocify.js"></script>
<script src="site_libs/navigation-1.1/tabsets.js"></script>
<link href="site_libs/highlightjs-9.12.0/textmate.css" rel="stylesheet" />
<script src="site_libs/highlightjs-9.12.0/highlight.js"></script>
<script src="site_libs/kePrint-0.0.1/kePrint.js"></script>
<link href="site_libs/lightable-0.0.1/lightable.css" rel="stylesheet" />
<link href="site_libs/font-awesome-5.1.0/css/all.css" rel="stylesheet" />
<link href="site_libs/font-awesome-5.1.0/css/v4-shims.css" rel="stylesheet" />
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
</style>
<style type="text/css">code{white-space: pre;}</style>
<script type="text/javascript">
if (window.hljs) {
hljs.configure({languages: []});
hljs.initHighlightingOnLoad();
if (document.readyState && document.readyState === "complete") {
window.setTimeout(function() { hljs.initHighlighting(); }, 0);
}
}
</script>
<link rel="stylesheet" href="styles.css" type="text/css" />
<style type = "text/css">
.main-container {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
img {
max-width:100%;
}
.tabbed-pane {
padding-top: 12px;
}
.html-widget {
margin-bottom: 20px;
}
button.code-folding-btn:focus {
outline: none;
}
summary {
display: list-item;
}
pre code {
padding: 0;
}
</style>
<style type="text/css">
.dropdown-submenu {
position: relative;
}
.dropdown-submenu>.dropdown-menu {
top: 0;
left: 100%;
margin-top: -6px;
margin-left: -1px;
border-radius: 0 6px 6px 6px;
}
.dropdown-submenu:hover>.dropdown-menu {
display: block;
}
.dropdown-submenu>a:after {
display: block;
content: " ";
float: right;
width: 0;
height: 0;
border-color: transparent;
border-style: solid;
border-width: 5px 0 5px 5px;
border-left-color: #cccccc;
margin-top: 5px;
margin-right: -10px;
}
.dropdown-submenu:hover>a:after {
border-left-color: #adb5bd;
}
.dropdown-submenu.pull-left {
float: none;
}
.dropdown-submenu.pull-left>.dropdown-menu {
left: -100%;
margin-left: 10px;
border-radius: 6px 0 6px 6px;
}
</style>
<script type="text/javascript">
// manage active state of menu based on current page
$(document).ready(function () {
// active menu anchor
href = window.location.pathname
href = href.substr(href.lastIndexOf('/') + 1)
if (href === "")
href = "index.html";
var menuAnchor = $('a[href="' + href + '"]');
// mark it active
menuAnchor.tab('show');
// if it's got a parent navbar menu mark it active as well
menuAnchor.closest('li.dropdown').addClass('active');
// Navbar adjustments
var navHeight = $(".navbar").first().height() + 15;
var style = document.createElement('style');
var pt = "padding-top: " + navHeight + "px; ";
var mt = "margin-top: -" + navHeight + "px; ";
var css = "";
// offset scroll position for anchor links (for fixed navbar)
for (var i = 1; i <= 6; i++) {
css += ".section h" + i + "{ " + pt + mt + "}\n";
}
style.innerHTML = "body {" + pt + "padding-bottom: 40px; }\n" + css;
document.head.appendChild(style);
});
</script>
<!-- tabsets -->
<style type="text/css">
.tabset-dropdown > .nav-tabs {
display: inline-table;
max-height: 500px;
min-height: 44px;
overflow-y: auto;
border: 1px solid #ddd;
border-radius: 4px;
}
.tabset-dropdown > .nav-tabs > li.active:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before {
content: "";
border: none;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open:before {
content: "";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs > li.active {
display: block;
}
.tabset-dropdown > .nav-tabs > li > a,
.tabset-dropdown > .nav-tabs > li > a:focus,
.tabset-dropdown > .nav-tabs > li > a:hover {
border: none;
display: inline-block;
border-radius: 4px;
background-color: transparent;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li {
display: block;
float: none;
}
.tabset-dropdown > .nav-tabs > li {
display: none;
}
</style>
<!-- code folding -->
<style type="text/css">
#TOC {
margin: 25px 0px 20px 0px;
}
@media (max-width: 768px) {
#TOC {
position: relative;
width: 100%;
}
}
@media print {
.toc-content {
/* see https://github.com/w3c/csswg-drafts/issues/4434 */
float: right;
}
}
.toc-content {
padding-left: 30px;
padding-right: 40px;
}
div.main-container {
max-width: 1200px;
}
div.tocify {
width: 20%;
max-width: 260px;
max-height: 85%;
}
@media (min-width: 768px) and (max-width: 991px) {
div.tocify {
width: 25%;
}
}
@media (max-width: 767px) {
div.tocify {
width: 100%;
max-width: none;
}
}
.tocify ul, .tocify li {
line-height: 20px;
}
.tocify-subheader .tocify-item {
font-size: 0.90em;
}
.tocify .list-group-item {
border-radius: 0px;
}
.tocify-subheader {
display: inline;
}
.tocify-subheader .tocify-item {
font-size: 0.95em;
}
</style>
</head>
<body>
<div class="container-fluid main-container">
<!-- setup 3col/9col grid for toc_float and main content -->
<div class="row">
<div class="col-xs-12 col-sm-4 col-md-3">
<div id="TOC" class="tocify">
</div>
</div>
<div class="toc-content col-xs-12 col-sm-8 col-md-9">
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">RWorkflow</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="set-up.html">
<span class="fa fa-clone"></span>
Set-up
</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
<span class="fa fa-calendar"></span>
Workshop Weekly Notes
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="week1.html">
<span class="fa fa-cogs"></span>
Week 1 RStudio + Version Control
</a>
</li>
<li>
<a href="week2.html">
<span class="fab fa-github-alt"></span>
Week 2 More Git/GitHub
</a>
</li>
<li>
<a href="week3.html">
<span class="fab fa-github"></span>
Week 3 GitHub
</a>
</li>
<li>
<a href="week4.html">
<span class="fa fa-file-code"></span>
Week 4 R Markdown
</a>
</li>
<li>
<a href="week5.html">
<span class="fa fa-chart-line"></span>
Week 5 ggplot2
</a>
</li>
<li>
<a href="week6.html">
<span class="fa fa-box"></span>
Week 6 packages
</a>
</li>
<li>
<a href="week7.html">
<span class="fa fa-circle"></span>
Week 7 roxygen and pkgdown
</a>
</li>
<li>
<a href="week8.html">
<span class="fa fa-box"></span>
Week 8 more packages
</a>
</li>
</ul>
</li>
<li>
<a href="https://rverse-tutorials.github.io/RWorkflow/">
<span class="fa fa-folder"></span>
Archive
</a>
</li>
<li>
<a href="https://rverse-tutorials.github.io/RWorkflow-NWFSC-2020">
<span class="fa fa-clock"></span>
2020 website
</a>
</li>
<li>
<a href="noaa.html">
<span class="fa fa-fish"></span>
NOAA
</a>
</li>
<li>
<a href="links.html">
<span class="fa fa-info"></span>
More resources
</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/RVerse-Tutorials/RWorkflow-NWFSC-2021">
<span class="fab fa-github"></span>
Repo
</a>
</li>
<li>
<a href="https://github.com/orgs/RWorkflow-Workshop-2021">Org</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
<div id="header">
<h1 class="title toc-ignore">Week 8: More R package tips</h1>
</div>
<table class="table" style="margin-left: auto; margin-right: auto;">
<tbody>
<tr>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Compartmentalized
</td>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Documented
</td>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Extendible
</td>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Reproducible
</td>
<td style="text-align:left;color: white !important;background-color: blue !important;width: 20%; ">
Robust
</td>
</tr>
</tbody>
</table>
<p>This week I will discuss topics that are specific for R package developers. These are topics that can tough to figure out when you are starting:</p>
<ul>
<li>How to set up a NAMESPACE</li>
<li>Passing <code>R CMD check</code></li>
<li>Coding GitHub Actions workflows</li>
<li>Some debugging and code speed analysis tips</li>
<li>Intro to C++ code in your package</li>
</ul>
<p>A good resource is Hadley Wickham’s book <a href="http://r-pkgs.had.co.nz/">R Packages</a>.</p>
<div id="depends-and-imports" class="section level2">
<h2>Depends and Imports</h2>
<p>Read about all the details of NAMESPACE in the R package book section on <a href="https://r-pkgs.org/namespace.html">NAMESPACEs</a>. But that has a lot of complex cases. I suggest trying to keep things as simple as you can.</p>
<pre><code>Package: MyNewPackage
Type: Package
Title: What the Package Does (Title Case)
Version: 0.1.0
Author: Who wrote it
Maintainer: The package maintainer <[email protected]>
Description: More about what it does (maybe more than one line)
Use four spaces when indenting paragraphs within the Description.
Depends: R (>= 4.0.0), ggplot2
Imports: forecast
Suggests: knitr
License: What license is it under? (GPL-3 or CCO for US Government)
Encoding: UTF-8
LazyData: true</code></pre>
<p><em>Note</em> see the <a href="https://github.com/RWorkflow-Workshop-2021/pkgdown-template"><strong>pkgdown-template</strong></a> for how to set up your license for a NOAA package.</p>
<div id="depends" class="section level3">
<h3><code>@Depends</code></h3>
<p>These packages that will be loaded when your package is loaded. So if you have <strong>ggplot2</strong> in <code>@Depends</code>, like above, then the user automatically can use <strong>ggplot2</strong> functions without issuing the command <code>library(ggplot2)</code>. Note for public packages, it is polite to alter the user’s workspace as little as possible so only put a package in <code>Depends</code> if you really need to or if it wouldn’t make sense to load your package and not have another package available.</p>
<p>If you have a package on <code>@Depends</code> then you must import that package in your NAMESPACE. Let’s say <strong>ggplot2</strong> (and only that) is on your <code>@Depends</code> line.</p>
<ul>
<li>If you are using <strong>roxygen2</strong>, then make a file called (say), <code>import_packages.R</code> in the R folder and add this code to it. The <code>NULL</code> is important.</li>
</ul>
<pre><code>#' @import ggplot2
NULL</code></pre>
<ul>
<li>If you are manually setting up your NAMESPACE, then add this code to it:</li>
</ul>
<pre><code>import(ggplot2)</code></pre>
<p>In your package functions, you should use <code>::</code> to access the functions from the packages on the <code>@Depends</code> line. Strictly speaking, you don’t have to, but I suggest you do. Otherwise a) if you ever move that package from <code>@Depends</code> to <code>@Imports</code>, you have much suffering in front of you as you search for all the functions and change to use <code>::</code>. b) Other people (or yourself) will know where every function comes from. c) Should you ever, perhaps inadvertently, create a function with the same name as one of the <code>@Depends</code> functions, you won’t run into a conflict.</p>
</div>
<div id="imports" class="section level3">
<h3><code>@Imports</code></h3>
<p>Imports are required for the package functions, but the user will not have access to the functions without calling <code>library(...)</code>. In your package, you must use <code>::</code> to access the functions from the packages on the <code>@Imports</code> line. <em>Most of your package dependencies will be here.</em></p>
<p>To limit the number of headaches that users face when trying to install your package, use as few packages on your <code>@Depends</code> and <code>@Imports</code> lines in DESCRIPTION file as possible. If your package does not need the package to work, then put the package on <code>@Suggests</code>.</p>
<p>Many packages are loaded by base R but you still need to declare those in <code>@Depends</code> or <code>@Imports</code>. For example <code>lm()</code> is in the <strong>stats</strong> package. <em>Tip</em> Routinely use <code>?function</code> to figure out what package a function comes from and then add <code>xyz::</code> to that function if you are writing a function for a package. Or add the package to <code>@Depends</code> and to your NAMESPACE.</p>
</div>
<div id="suggests" class="section level3">
<h3><code>@Suggests</code></h3>
<p>These packages are used in vignettes or examples. You (the developer) will need these installed when you check your package.</p>
</div>
<div id="do-your-need-r-on-depends" class="section level3">
<h3>Do your need R on <code>@Depends</code></h3>
<p>No not unless you have a version dependency. There were some big changes in R 4.0 so you might need that dependency. If you are doing a public R package, search about for options for testing your package under different R versions.</p>
</div>
<div id="what-should-you-put-on-your-depends-and-imports-lines" class="section level3">
<h3>What should you put on your Depends and Imports lines?</h3>
<p>First off, when you are starting, don’t worry too much about this. Just add packages that are needed as you work on your functions.</p>
<ul>
<li><p>ALWAYS use <code>::</code> to use functions from other packages in your package functions. Seriously. You will save yourself so many headaches down the road by being able to search for <code>xyzpackage::</code> to find all that packages functions. Why? Trust me, one day you will want to swap out packages or remove dependencies. Note, this can be a hassle with functions like <code>ggplot()</code> which use functions within their calls and you have to use <code>::</code> everywhere. Like so</p>
<pre class="r"><code>ggplot2::ggplot(df) +
ggplot2::geom_point(ggplot2::aes(gp, y))</code></pre>
<p>Arg. Another example is say a GAM call:</p>
<pre class="r"><code>mgcv::gam(a ~ mgcv::s(b), data=df)</code></pre>
<p>But this is just for your package functions. In your <em>scripts</em>, you’d probably use a <code>library()</code> call.</p></li>
<li><p>Never ever use <code>library()</code> (or <code>require()</code>) in a function! Use <code>xyzfunction::function</code>. Sure use <code>library()</code> in your scripts, but never in a package function. When you add a function from a new package to your function, add those packages to <code>@Depends</code> or <code>@Imports</code> in your DESCRIPTION file as you go along.</p></li>
<li><p>Every so often check that you don’t have packages on <code>@Depends</code> and <code>@Imports</code> that you don’t use. Just do a Edit > Find in Files… search for <code>xyzpackage::</code> to find out if you are still using <code>xyzpackage</code>.</p></li>
<li><p>How do you know if you forgot a dependency or forgot a <code>::</code> somewhere? A few ways:</p>
<ol style="list-style-type: decimal">
<li>From the Build tab, use More > Check Package. That should show package dependency errors (plus a whole slew of other problems for you to work through).</li>
<li>Do Session > Restart R to close all your loaded packages. Then load your package with <code>library(yourpackagename)</code> and try your functions. Things will fail if you have a package in <code>@Imports</code> but forgot a <code>::</code> somewhere.</li>
</ol></li>
</ul>
</div>
<div id="my-strategy" class="section level3">
<h3>My strategy</h3>
<p>I have R packages that are mainly for my personal use. I use the package to make sure I have access to the various packages that I’ll be using. So for example, if I am doing work on my sardine papers, I have set of packages that I use. When I issue the command <code>library(SardineForecast)</code> a bunch of packages are loaded. This makes it handy for me, but all those dependencies makes it a <strong>huge</strong> hassle to install the package from GitHub for my collaborators (and even a hassle for me to install from GitHub). Huge Hassle. Invariably one of the 15 packages that I need will itself have a dependency that won’t load and then I have to debug that. If I need collaborators, who are on different operating systems and various versions of R to install it, it’s a suffer-fest.</p>
<p>For my MARSS package, I have only 3 non-base dependencies in the <code>@Imports</code> line and nothing on the <code>@Depends</code> line besides R. Then on the <code>@Suggests</code> line, I have a bunch of packages that are used in the vignettes. MARSS is easy to install from GitHub (though it is also hosted on CRAN).</p>
</div>
</div>
<div id="passing-package-check" class="section level2">
<h2>Passing package Check</h2>
<p>The is also called <code>R CMD check</code> but if you are using RStudio, you can use Build tab > More… > Check</p>
<p><code>R CMD check</code> has many errors that can be hard to decipher. I am going to go through the common hard-to-decipher ones.</p>
<div id="ggplot2-and-dplyr-functions" class="section level3">
<h3><strong>ggplot2</strong> and <strong>dplyr</strong> functions</h3>
<p>You will get weird errors about undeclared global variables if you use <strong>ggplot2</strong> and <strong>dplyr</strong> functions.</p>
<p>This will thrown an error:</p>
<pre><code>ggplot(df, aes(x=x, y=y))</code></pre>
<p>You need to explicitly say that <code>x</code> and <code>y</code> come from the data argument (<code>df</code>). Technically, the <code>ggplot()</code> arguments are <code>ggplot(data=df, mapping=aes())</code>.</p>
<pre><code>ggplot2::ggplot(df, ggplot2::aes(x=.data$x, y=.data$y))</code></pre>
<p>A lot of the <strong>dplyr</strong> functions must also be specified like this. This will thrown an check error:</p>
<pre><code>dplyr::select(df, x)</code></pre>
<p>You need to do this.</p>
<pre><code>dplyr::select(df, .data$x)</code></pre>
<p>All the <strong>dplyr</strong> verbs will throw this check error: <code>arrange()</code>, <code>filter()</code>, <code>mutate()</code>, etc.</p>
</div>
<div id="pipes" class="section level3">
<h3><code>%>%</code> pipes</h3>
<p><code>%>%</code> this is actually a function and you need to import it from the <strong>magrittr</strong> package.</p>
<ul>
<li>If you are using <strong>roxygen2</strong>, then make a file called (say), <code>import_packages.R</code> in the R folder and add this code to it. The <code>NULL</code> is important.</li>
</ul>
<pre><code>#' @importFrom magrittr %>%
NULL</code></pre>
<ul>
<li>If you are manually setting up your NAMESPACE, then add this code to it:</li>
</ul>
<pre><code>importFrom(magrittr, %>%)</code></pre>
<p>Note,</p>
<ul>
<li><strong>magrittr</strong> 2.0 fixes some of the past issues with slow pipes. You could put in a dependency for 2.0 using</li>
</ul>
<pre><code>Depends: magrittr (>= 2.0)</code></pre>
<p>in your DESCRIPTION file. Note, R is picky about the space in front of the version number.</p>
<ul>
<li><a href="https://www.jumpingrivers.com/blog/new-features-r410-pipe-anonymous-functions/">R 4.1 is introducting a native pipe</a> <code>|></code>. It’s a little than the <strong>magrittr</strong> pipe. If you use that in your package, you’ll need to add a dependency on R 4.1:</li>
</ul>
<pre><code>Depends: R (>= 4.1)</code></pre>
</div>
<div id="common-errors" class="section level3">
<h3>Common errors</h3>
<ul>
<li>Undeclared global functions: You forgot <code>::</code> somewhere</li>
<li>Undeclared global. That’s either a bug or its the <strong>ggplot2</strong> and <strong>dplyr</strong> problem.</li>
<li>Examples have problems. Note check runs through these alphabetically. Sometimes it can be hard to figure out where the problem was.
<ul>
<li><p>Use <code>dontrun{}</code> to make code that won’t run. Horribly, it can be really hard to actually not run this code, so make sure the code is correct. If you are showing bad code, then you’ll need to comment it out.</p></li>
<li><p>Use <code>donttest{}</code>. It is hard to get this respected when you run check. Setting the system env flag should force <code>R CMD check</code> to respect <code>donttest{}</code>:</p>
<pre><code>Sys.setenv("R_CHECK_DONTTEST_EXAMPLES"=FALSE)</code></pre>
<p>But R Studio’s ‘check’ via the Build tab uses <code>devtools::check()</code> and that doesn’t respect that flag. It hard codes in <code>--run-donttest</code>. So go to Tools > Project Options > Build Tools and uncheck the little box that says ‘Use devtools functions if available’. Then try clicking Check from the Build tab. R package developers have been complaining about this a lot. It is new to R 4.0.</p>
<p>For getting <code>R CMD check</code> to pass in a GitHub Action when you have <code>donttest{}</code> in examples, see the comments below on GitHub Actions.</p></li>
</ul></li>
</ul>
</div>
</div>
<div id="writing-s3-methods" class="section level2">
<h2>Writing S3 methods</h2>
<p>S3 classes and methods are easy to make.</p>
<div id="step-1.-set-the-class-of-your-object." class="section level3">
<h3>Step 1. Set the class of your object.</h3>
<p>So let’s say your package fits a model via <code>lm()</code> and returns that fit. Then just assign an additional class to the fit:</p>
<pre><code>fit <- lm(a ~ b, data=df)
class(fit) <- c("foo", class(fit))</code></pre>
</div>
<div id="step-2.-write-a-method-function" class="section level3">
<h3>Step 2. Write a method function</h3>
<pre><code>print.foo <- function(x){
cat("Hello, this is a foo object!\n")
cat(paste("Your r2 is", summary(fit)$adj.r.squared), "\n")
}</code></pre>
</div>
<div id="step-3.-declare-the-method-in-your-namespace" class="section level3">
<h3>Step 3. Declare the method in your NAMESPACE</h3>
<pre><code>S3method(print, foo)</code></pre>
</div>
</div>
<div id="debugging-tools" class="section level2">
<h2>Debugging Tools</h2>
<div id="entering-functions" class="section level3">
<h3>Entering functions</h3>
<p>This is an personal list of some simple degugging tools. RStudio has debugging tools too but I don’t know those.</p>
</div>
<div id="debug" class="section level3">
<h3><code>debug()</code></h3>
<pre><code>debug(function)
undebug(function)</code></pre>
<p>Allows you to go line by line through the function and interact at the command line. Use the little icons above the console window to step out of <code>for</code> loops.</p>
</div>
<div id="browser" class="section level3">
<h3><code>browser()</code></h3>
<p>Put in your code where you want to enter the function.</p>
</div>
<div id="optionserrorrecover" class="section level3">
<h3><code>options(error=recover)</code></h3>
<p>Type this on the command line. Puts you into <code>browser()</code> at the point of the error (instead of a specific spot)</p>
</div>
<div id="traceback" class="section level3">
<h3><code>traceback()</code></h3>
<p>Tells you where your code stopped. Note RStudio will show this also. Check your Project Options under Tools if you don’t see Traceback on errors.</p>
</div>
</div>
<div id="analyzing-code-speed" class="section level2">
<h2>Analyzing code speed</h2>
<div id="system.time-functionname" class="section level3">
<h3><code>system.time( functionname )</code></h3>
<p>How long does your function take?</p>
</div>
<div id="profiling" class="section level3">
<h3>Profiling</h3>
<p><code>Rprof()</code> and <code>summaryRprof()</code></p>
<p>Profile your code to find out what are the time hogs.</p>
<pre class="r"><code>a <- matrix(0,10,100)
Rprof(tmp<-tempfile())
for(i in 1:10000){ b <- t(a)%*%a }
Rprof()
summaryRprof(tmp)$by.self</code></pre>
<pre><code>## self.time self.pct total.time total.pct
## "%*%" 0.62 96.88 0.62 96.88
## "t.default" 0.02 3.12 0.02 3.12</code></pre>
<pre class="r"><code>Rprof(NULL) #stop profiling</code></pre>
</div>
<div id="profvis-package" class="section level3">
<h3><strong>profvis</strong> package</h3>
<p>Check out the <a href="https://rstudio.github.io/profvis/"><strong>profvis</strong></a> for profiling your code. I haven’t used it but others have said it’s a great tool.</p>
</div>
<div id="microbenchmark" class="section level3">
<h3><strong>microbenchmark</strong></h3>
<p>This is a handy package for comparing speeds of code.</p>
<pre class="r"><code>library(microbenchmark)
a <- 2
res <- microbenchmark(2 + 2, 2 + a, sum(2, a), sum(2, 2))
ggplot2::autoplot(res)</code></pre>
<pre><code>## Coordinate system already present. Adding new coordinate system, which will replace the existing one.</code></pre>
<pre><code>## Warning: Transformation introduced infinite values in continuous y-axis</code></pre>
<pre><code>## Warning: Removed 11 rows containing non-finite values (stat_ydensity).</code></pre>
<p><img src="week8-adv-packages_files/figure-html/unnamed-chunk-5-1.png" width="672" /></p>
<p>This shows an example of code using <a href="https://www.datacamp.com/community/tutorials/pipe-r-tutorial">piping</a> (<code>%>%</code>) versus without. This is why I do not use piping in my simulations. It is slow though it has gotten much faster in <strong>magrittr</strong> 2.0.</p>
<pre class="r"><code>library(magrittr)
x <- c(0.109, 0.359, 0.63, 0.996, 0.515, 0.142, 0.017, 0.829, 0.907)
fun1 <- function(x){
x %>% log() %>%
diff() %>%
exp() %>%
round(1)
}
fun2 <- function(x){ round(exp(diff(log(x))), 1) }
res <- microbenchmark::microbenchmark(fun1(x), fun2(x))
ggplot2::autoplot(res)</code></pre>
<pre><code>## Coordinate system already present. Adding new coordinate system, which will replace the existing one.</code></pre>
<p><img src="week8-adv-packages_files/figure-html/unnamed-chunk-6-1.png" width="672" /></p>
</div>
</div>
<div id="styling-your-code" class="section level2">
<h2>Styling your code</h2>
<p>You should stick with a uniform style guide to make your code easier to follow. I use the tidyverse style guide with the <a href="https://www.tidyverse.org/blog/2017/12/styler-1.0.0/"><strong>styler</strong> R package</a>. <strong>styler</strong> has an RStudio Addin which does all the work of styling my code for me. Install the package, restart RStudio, and then go to Tools > Addins > Browse Addins. Scroll down to styler, and select the file(s), you want to style.</p>
</div>
<div id="byte-compile" class="section level2">
<h2>Byte Compile</h2>
<p>Adding this line to your DESCRIPTION file can really speed up your code. This is one of the advantages of putting your functions in a package. It can actually make your functions faster.</p>
<pre><code>ByteCompile: TRUE</code></pre>
</div>
<div id="installing-from-github" class="section level2">
<h2>Installing from GitHub</h2>
<p>The code you will use to install from GitHub is:</p>
<pre><code>library(devtools)
install_github("youraccount/MyNewPackage")</code></pre>
<p>For example to install the package on ‘RVerse-Tutorials’, you would use</p>
<pre><code>install_github("RVerse-Tutorials/TestPackage")</code></pre>
<p>Also look into <strong>remotes</strong>. I see that used now instead of <strong>devtools</strong> for this.</p>
<p>To install the latest release rather than the main branch use <code>@release</code> at the end.</p>
<pre><code>install_github("RVerse-Tutorials/TestPackage@release")</code></pre>
<div id="installing-from-github-headaches" class="section level3">
<h3>Installing from GitHub headaches</h3>
<p>If you are on a Windows machine and get an error saying ‘loading failed for i386’ or similar, then try</p>
<pre><code>options(devtools.install.args = "--no-multiarch")</code></pre>
<p>If R asks you to update packages, and then proceeds to fail at installation because of a warning that a package was built under a later R version than you have on your computer, use</p>
<pre><code>Sys.setenv(R_REMOTES_NO_ERRORS_FROM_WARNINGS=TRUE)</code></pre>
<p>If R asks you to update packages, you don’t need to update (normally). If you do update, and it asks if you want to install from source, you can probably say ‘No’. It is very unlikely that the package you trying to install needs the most updated version of a package. If that were the case, the package writer could have explicitly stated a version dependency, like <code>forecast (>=2.0)</code>.</p>
<p>If R simply won’t install a package from GitHub (or CRAN even) because of a package dependency problem, something like <code>can't install because couldn't remove old installation</code> error. Then click on the Packages tab (lower right panel) and click Install. Look at where R is installing packages. There might be more than one place. Close all your RStudio windows (exit altogether) and go to those locations and delete the library folder(s) for the offending package. Then open RStudio and re-install that package.</p>
<p>To limit the number of headaches that users face when trying to install your package from GitHub/Lab, use as few packages on your <code>@Depends</code> and <code>@Imports</code> lines in DESCRIPTION file as possible. If your package does not need the package to work, then put the package on <code>@Suggests</code>.</p>
</div>
</div>
<div id="github-actions" class="section level2">
<h2>GitHub Actions</h2>
<p>This helps you automate tasks when you push (say) changes to GitHub. The super common one is check package and getting that nifty <em>Passing</em> badge.</p>
<div class="figure">
<img src="https://github.com/RWorkflow-Workshop-2021/pkgdown-template/workflows/R-CMD-check/badge.svg" alt="" />
<p class="caption">badge</p>
</div>
<div id="getting-started." class="section level3">
<h3>Getting started.</h3>
<pre><code>usethis::use_github_actions()</code></pre>
<p>Note what it does because you might need to change things.</p>
<pre><code>usethis::use_github_actions_badge()</code></pre>
<p>Set up the <code>R CMD check</code> badge.</p>
</div>
<div id="start-adapting-for-your-own-purposes" class="section level3">
<h3>Start adapting for your own purposes</h3>
<p>Look at examples:</p>
<ul>
<li>Start here <a href="https://github.com/r-lib/actions">r-lib/actions</a></li>
<li>Here how I am using it: <a href="https://github.com/nwfsc-math-bio/VRData/tree/master/.github/workflows">VRData</a> to run scripts on data that is pushed.</li>
<li>Read all about <a href="https://orchid00.github.io/actions_sandbox/">Github actions with R</a></li>
<li><a href="https://fromthebottomoftheheap.net/2020/04/30/rendering-your-readme-with-github-actions/">This blog helped me</a>. It’s a write-up of a colleague putting together his first GitHub Action.</li>
<li><a href="https://github.com/UW-Upwelling-Project/imageryML/blob/main/.github/workflows/R-CMD-check.yaml">Here</a> is an example of setting the environment so that <code>R CMD check</code> doesn’t run <code>donttest{}</code> in examples.</li>
<li>Look in the <a href="https://github.com/nmfs-fish-tools">Fisheries Integrated Toolbox</a> for the <code>.github/workflows</code> folder and look at examples of workflows.</li>
</ul>
<p>You can also use GitHub Actions is <a href="https://youtu.be/R8_veQiYBjI">many more ways</a> to help you automate workflows.</p>
</div>
</div>
<div id="c-code" class="section level2">
<h2>C++ code</h2>
<p>Read this the <a href="https://r-pkgs.org/src.html#src">compiled code</a> section in the R package handbook.</p>
</div>
<hr>
<div style="text-align: center">
<i class="fas fa-cubes"></i> NWFSC Math Bio Program <i class="fas fa-cubes"></i>
</div>
</div>
</div>
</div>
<script>
// add bootstrap table styles to pandoc tables
function bootstrapStylePandocTables() {
$('tr.odd').parent('tbody').parent('table').addClass('table table-condensed');
}
$(document).ready(function () {
bootstrapStylePandocTables();
});
</script>
<!-- tabsets -->
<script>
$(document).ready(function () {
window.buildTabsets("TOC");
});
$(document).ready(function () {
$('.tabset-dropdown > .nav-tabs > li').click(function () {
$(this).parent().toggleClass('nav-tabs-open');
});
});
</script>
<!-- code folding -->
<script>
$(document).ready(function () {
// temporarily add toc-ignore selector to headers for the consistency with Pandoc
$('.unlisted.unnumbered').addClass('toc-ignore')
// move toc-ignore selectors from section div to header
$('div.section.toc-ignore')
.removeClass('toc-ignore')
.children('h1,h2,h3,h4,h5').addClass('toc-ignore');
// establish options
var options = {
selectors: "h1,h2",
theme: "bootstrap3",
context: '.toc-content',
hashGenerator: function (text) {
return text.replace(/[.\\/?&!#<>]/g, '').replace(/\s/g, '_');
},
ignoreSelector: ".toc-ignore",
scrollTo: 0
};
options.showAndHide = false;
options.smoothScroll = true;
// tocify
var toc = $("#TOC").tocify(options).data("toc-tocify");
});
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
</script>
</body>
</html>