-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
757 lines (568 loc) · 23.9 KB
/
index.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
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>Creating packages</title>
<meta charset="utf-8" />
<meta name="author" content="Lluís Revilla Sancho Slides: " />
<script src="libs/header-attrs-2.11/header-attrs.js"></script>
<link href="libs/remark-css-0.0.1/default.css" rel="stylesheet" />
<link href="libs/tile-view-0.2.6/tile-view.css" rel="stylesheet" />
<script src="libs/tile-view-0.2.6/tile-view.js"></script>
<script src="libs/freezeframe-5.0.2/freezeframe.min.js"></script>
<script src="libs/xaringanExtra-freezeframe-0.0.1/freezeframe-init.js"></script>
<script id="xaringanExtra-freezeframe-options" type="application/json">{"selector":"img[src$=\"gif\"]","trigger":"click","overlay":false,"responsive":true,"warnings":true}</script>
<script src="libs/clipboard-2.0.6/clipboard.min.js"></script>
<link href="libs/xaringanExtra-clipboard-0.2.6/xaringanExtra-clipboard.css" rel="stylesheet" />
<script src="libs/xaringanExtra-clipboard-0.2.6/xaringanExtra-clipboard.js"></script>
<script>window.xaringanExtraClipboard(null, {"button":"Copy Code","success":"Copied!","error":"Press Ctrl+C to Copy"})</script>
<script src="libs/js-cookie-3.0.0/js.cookie.js"></script>
<script src="libs/peerjs-1.3.1/peerjs.min.js"></script>
<script src="libs/tiny.toast-1.0.0/toast.min.js"></script>
<link href="libs/xaringanExtra-broadcast-0.2.6/broadcast.css" rel="stylesheet" />
<script src="libs/xaringanExtra-broadcast-0.2.6/broadcast.js"></script>
<meta name="github-repo" content="llrs/ghana_packages"/>
<meta name="twitter:title" content="Creating packages"/>
<meta name="twitter:description" content="Workshop about how to create packages For R User Group Gahna on the ."/>
<meta name="twitter:url" content="https://ghana_packages.llrs.dev"/>
<meta name="twitter:image" content="https://ghana_packages.llrs.dev/index_files/figure-html/title_slide_screenshot.png"/>
<meta name="twitter:image:alt" content="Image of the first slide for Reviewing packages; how does it work? . Done for the R User Group Ghana on 2021/09 by Lluís Revilla Sancho"/>
<meta name="twitter:card" content="summary_large_image"/>
<meta name="twitter:creator" content="@Lluis_Revilla"/>
<meta name="twitter:site" content="@Lluis_Revilla"/>
<meta property="og:title" content="Creating packages"/>
<meta property="og:description" content="Workshop about how to create packages For R User Group Gahna on the ."/>
<meta property="og:url" content="https://ghana_packages.llrs.dev"/>
<meta property="og:image" content="https://ghana_packages.llrs.dev/index_files/figure-html/title_slide_screenshot.png"/>
<meta property="og:image:alt" content="Image of the first slide for Reviewing packages; how does it work? . Done for the R User Group Ghana on 2021/09 by Lluís Revilla Sancho"/>
<meta property="og:type" content="website"/>
<meta property="og:locale" content="en_US"/>
<meta property="article:author" content="Lluís Revilla Sancho"/>
<link href="libs/countdown-0.3.5/countdown.css" rel="stylesheet" />
<script src="libs/countdown-0.3.5/countdown.js"></script>
<link rel="stylesheet" href="my-theme.css" type="text/css" />
</head>
<body>
<textarea id="source">
class: left, center, middle, inverse, title-slide
# Creating packages
## with devtools and usethis
### <a href="https://llrs.dev">Lluís Revilla Sancho</a> <a href="https://twitter.com/Lluis_Revilla"><svg viewBox="0 0 512 512" style="height:1em;position:relative;display:inline-block;top:.1em;" xmlns="http://www.w3.org/2000/svg"> <path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path></svg></a> <br> <a href="https://ghana.llrs.dev">Slides:</a> <a href="https://github.com/llrs/ghana_packages/"><svg viewBox="0 0 496 512" style="height:1em;position:relative;display:inline-block;top:.1em;" xmlns="http://www.w3.org/2000/svg"> <path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg></a>
### IDIBAPS, CIBEREHD
### 2021-09-04 <sup><sub>(updated: 2021-12-27)</sub></sup>
---
# About
.left[**myself**
I'm [Lluís Revilla Sancho](https://llrs.dev), a bioinformatician working on a research center of a hospital.
Three packages on repositories: [BioCor](https://bioconductor.org/packages/BioCor/), [BaseSet](https://cran.r-project.org/package=BaseSet) and [experDesign](https://cran.r-project.org/package=experDesign).
I have reviewed some packages on [rOpenSci](https://ropensci.org) and informally at [Bioconductor](https://bioconductor.org).
]
.center[**you**
- ... know how to use R and write functions.
- ... are using [RStudio IDE](https://www.rstudio.com/products/rstudio/download/).
- ... have not created a package.
- ... are using a computer with the latest [devtools](https://cran.r-project.org/package=devtools) installed.
]
If you want to be sure run this code:
```r
if (!require("devtools", character.only = TRUE, quietly = TRUE)) {
install.packages("devtools")
}
if (!require("covr", character.only = TRUE, quietly = TRUE)) {
install.packages("covr")
}
```
???
[devtools](https://cran.r-project.org/package=devtools) is a package to help develop packages.
Currently many actions are done via [usethis](https://cran.r-project.org/package=usethis).
If you see something like `usethis::function` it means we call the `function` from usethis package.
---
name:resources
# Resources
- [R extensions](https://cran.r-project.org/doc/manuals/r-release/R-exts.html "Offical complete instructions"): Official documentation, everything is answered here
- [R packages](https://r-pkgs.org/ "R pakages"): A book more digestible and using other packages and tools to create packages.
- [Package primer](https://kbroman.org/pkg_primer/ "R package primer a minimal tutorial"): Website explaining different aspects of creating a package.
- [Creating R packages from scratch](https://hilaryparker.com/2014/04/29/writing-an-r-package-from-scratch/ "Creating a cats package"): Very easy to follow blog post.
- [Updated version by Tomas Westlake](https://r-mageddon.netlify.app/post/writing-an-r-package-from-scratch/ "Creating a cats package with usethis"): Similar to the post above but updated with more modern tools.
- [rOpenSci](https://devguide.ropensci.org/): A book about writing packages and maintaining them on good shape.
- [Video](https://www.youtube.com/watch?v=IlWMkz769B4) with a similar workshop showing live the code used.
Many resources!
You can also find help online (always check the etiquette)
- Asking your local community
- [Asking on Twitter #rstats](https://www.t4rstats.com/)
- [Asking on Stack Overflow](https://stackoverflow.com/questions/5963269)
- [Asking on Rstudio forum](https://community.rstudio.com/)
???
Resources used to create this workshop
[Maëlle post](https://masalmon.eu/2017/12/11/goodrpackages/): how to write good packages is also recommended.
---
## Example
.left-column[
<img src="images/tidyverse_dtplyr.png" title="Tree view of the dtplyr package repository on 2021/08/06." alt="Tree view of the dtplyr package repository on 2021/08/06." width="100%" />
]
.right-column[
- `.github` folder: Files specific to GitHub (this isn't necessary/[Advanced content](#advanced))
- A `R` folder with [*.R files](#r-files): your code.
- A `man` folder with [*.rd files](#rd-files): your documentation.
- A `tests` folder: [Check the code](#tests) of the package.
- A [`vignette` folder](#vignettes): Long documentation; not just examples.
- A `.Rbuildignore`: A file describing what to omit when building the package.
- A [`DESCRIPTION` file](#description): Summary and description of the package.
- A [`LICENSE` file](#licenses): The conditions under the package is released.
- A [`NAMESPACE` file](#namespace): What this package shares and needs.
- A [`NEWS` file](#news): What has changed since last release.
- A [`README`](#readme): How to install and why this packages is needed and some basic examples.
]
---
## Template
.pull-left[
```r
create_package("dogs")
```
It will create a dogs project within the directory and will open a new Rstudio window.
]
.pull-right[
- Creates DESCRIPTION file
- Creates R files
- Creates documentation files
- Creates NAMESPACE file
]
--
.pull-left[
Suggestions for packages:
- fruits
- cats
- food
- sports
- ...
]
.pull-right[
![:scale 70% "Ghana market with cattle"](https://live.staticflickr.com/4041/4584360223_5ab315bfa4_b.jpg)
]
<div class="countdown" id="timer_61c9f755" style="top:0;right:0;margin:5%;" data-warnwhen="0">
<code class="countdown-time"><span class="countdown-digits minutes">01</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">30</span></code>
</div>
---
name: description
## DESCRIPTION
.pull-left[
```
Package: BaseSet
Title: Short Descriptiono in Title Case
Version: 0.0.9000
Authors@R: c(person(given = "Lluís",
family = "Revilla Sancho",
role = c("aut", "cre", "cph"),
email = "[email protected]"),
...)
Description: A long description of the pacakge
License: MIT + file LICENSE
Depends:
R (>= 4.0.0)
Imports:
dplyr (>= 1.0.0),
methods
Suggests:
covr,
knitr,
rmarkdown,
spelling,
testthat (>= 2.1.0)
VignetteBuilder:
knitr
Encoding: UTF-8
Language: en-US
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.1
```
]
???
Name of the package, description of the package, maintainer, relationships with other packages...
Language does not need to be on English, it can be in other languages
--
.pull-right[
Modify the DESCRIPTION of your package.
- Add a good title.
- Add a Description.
- Add yourself as an author.
<div class="countdown" id="timer_61c9f73b" style="top:0;right:0;" data-warnwhen="0">
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
]
---
name:r-files
## Add R files
On the new package R console run:
```r
usethis::use_r("dog_functions")
```
It will create a `dog_functions.R` file inside the R folder (and it will open it).
.center[
![:scale 50% "GIF of hadly wickham saying just typing R code"](https://c.tenor.com/pnK2MIoEAccAAAAC/hadley-wickham.gif)
]
---
## Add R files
1. Only valid R code: functions, objects, environments that don't depend on previous code executed.
2. If a function uses a function of an other package use `package::function`
3. Add that package to the appropriate site on [Description](#description)
4. add a `#' @importFrom package function` (See next slide)
```r
meow <- function() {
message("meow")
}
```
<div class="countdown" id="timer_61c9f8dd" style="top:0;right:0;" data-warnwhen="0">
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
---
name:namespace
## NAMESPACE
Import code of other packages and export code of your package:
```r
import(dplyr)
importFrom(methods, is)
export(meow)
```
--
If using roxygen2 you can use:
```r
#' @import dplyr
#' @importFrom methods is
is_meow <- function(x){
methods(x, "meow")
}
#' @export # To make it available to others
meow <- function() {
message("meow")
}
```
Which will be written to the NAMESPACE file when [updating the documentation](#rd-files)
???
Important file!
---
name:readme
## Documentation
### README
First page people might read if on Github or on a computer.
```r
usethis::use_readme_rmd() # build_readme()
```
Example README:
<img src="images/data.table_README.png" width="2531" />
--
Modify README:
<div class="countdown" id="timer_61c9f742" style="top:0;right:0;" data-warnwhen="0">
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
---
name:rd-files
## Documentation
### Function documentation
.pull-left[
Using [roxygen2](https://cran.r-project.org/package=roxygen2), example:
```r
#' Title
#'
#' Description
#' @param x
#'
#' @return Values returned
#' @export
#'
#' @examples
#' a("hi")
a <- function(x) {
print(x)
}
```
]
.pull-right[
Convert this specials comments into *.Rd files with:
```r
document()
```
]
???
In Rstudio you can insert the skeleton with <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd> .
In Rstudio you can convert the special comments into documentation with <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd> .
--
.center[Write your own documentation]
<div class="countdown" id="timer_61c9f885" style="top:0;right:0;" data-warnwhen="0">
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
---
name: vignettes
## Documentation
### Vignettes
Long form of documentation, how multiple functions work together (It can use functions of other packages)
```r
usethis::use_vignette(name = "intro")
```
--
Write your own vignette:
- Fruits growing
- Dogs/cats exploring the house or the neighborhood
- A match of your sport
- ...
<div class="countdown" id="timer_61c9f768" style="top:0;right:0;" data-warnwhen="0">
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
---
name: tests
## Tests
Make sure that what you think it happens it really stays that way:
Can be quite complicated
```r
use_testthat()
use_test("meow")
```
.pull-left[
Change from:
```r
test_that("multiplication works", {
expect_equal(2 * 2, 4)
})
```
]
.pull-right[
To (**If** you used the [meow function](#namespace)):
```r
test_that("mewo works", {
expect_message(meow(), "meow")
})
```
]
--
<div class="countdown" id="timer_61c9f927" style="top:0;right:0;" data-warnwhen="0">
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
---
name:licenses
## Licenses
If sharing the package what can people do with your package?
- **Permissive** licenses: Code with a permissive license can be freely copied, modified, and published, and the only restriction is that the license must be preserved.
- **Copyleft** licenses: if you publish modified versions or bundle with other code, the modified version or complete bundle must also be licensed with the same license.
```r
usethis::use_mit_license() # Permissive
usethis::use_gpl_license() # Copyleft
usethis::use_proprietary_license() # Own license
```
.right[<sup>[Source](https://r-pkgs.org/license.html)</sup>]
???
---
name: news
## NEWS
Sharing what changed between releases
```r
usethis::use_news_md()
```
The file has this structure:
```raw
# dogs 0.0.0.9000
* Added a `NEWS.md` file to track changes to the package.
```
Version of the package
Text describing changes on the packages.
It is a good place to acknowledge minor contributions
???
Modify to explain the changes.
Good idea to use - (#issue, `@user`)
--
<div class="countdown" id="timer_61c9f94c" style="top:0;right:0;" data-warnwhen="0">
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
---
## Finishing and checking
Check if everything works well! It can take some time.
```r
check()
```
It should pass without Warnings or Errors.
If not (most probable) fix the problems found
???
Automatically runs the test and checks the package compilance with common quality standards
---
## That's all
.center[
![:scale 60% "That's all folks"](https://media.giphy.com/media/lD76yTC5zxZPG/giphy.gif)
]
---
## Developing your package
- [Modify or add](#r-files) more *.R files to the R folder
- [Add or change function's documentation](#rd-files) and [vignettes](#vignettes) and update it (`document()`)
- Check the package (`check()`)
- Repeat.
---
## Questions, doubts, comments?
- It is normal to not succeed on the first 5-10 attempts!!
- Search, ask whenever you need.
Thanks for following through it.
![:scale 40% ""](https://media1.giphy.com/media/f2HiQKaEkaKwo/giphy.gif?cid=ecf05e475uwtpser5kqd7t5pwoz8vdrrkbp817x708vdb4ci&rid=giphy.gif&ct=g)
???
---
name:advanced
# Advanced
## Git
Set up git as a control version system. This allows to share on [GitHub](https://github.com).
To set it up use:
```r
usethis::use_git()
```
???
Version controls helps you to modify code securely and interact with others (and receive their suggestions).
---
# Advanced
## Github
Share the package on Github:
```r
usethis::use_github()
```
Add checks
```r
usethis::use_github_action_check_release()
```
Use the git panel of Rstudio to commit and push updates on the package.
???
Having a package public on github can help on your CV and to get users.
---
# Advanced
## Code coverage
Report how much of the package is tested.
```r
usethis::use_coverage()
```
It can be done offline on your computer `covr::report()` but usually also reported online.
???
Aim to have high code coverage (above 75%).
High code coverage prevents your users (and yourself) to push changes that do not work.
---
# Advanced
## Pkgdown website
Now that the package is working and public, a website makes it easier for users to find documentation.
```r
usethis::use_pkgdown()
usethis::use_pkgdown_github_pages()
```
???
It is also great for publicity, so others can read and learn about your package without installing it.
</textarea>
<style data-target="print-only">@media screen {.remark-slide-container{display:block;}.remark-slide-scaler{box-shadow:none;}}</style>
<script src="https://remarkjs.com/downloads/remark-latest.min.js"></script>
<script src="macros.js"></script>
<script>var slideshow = remark.create({
"ratio": "16:9",
"highlightStyle": "github",
"highlightLines": true,
"countIncrementalSlides": false
});
if (window.HTMLWidgets) slideshow.on('afterShowSlide', function (slide) {
window.dispatchEvent(new Event('resize'));
});
(function(d) {
var s = d.createElement("style"), r = d.querySelector(".remark-slide-scaler");
if (!r) return;
s.type = "text/css"; s.innerHTML = "@page {size: " + r.style.width + " " + r.style.height +"; }";
d.head.appendChild(s);
})(document);
(function(d) {
var el = d.getElementsByClassName("remark-slides-area");
if (!el) return;
var slide, slides = slideshow.getSlides(), els = el[0].children;
for (var i = 1; i < slides.length; i++) {
slide = slides[i];
if (slide.properties.continued === "true" || slide.properties.count === "false") {
els[i - 1].className += ' has-continuation';
}
}
var s = d.createElement("style");
s.type = "text/css"; s.innerHTML = "@media print { .has-continuation { display: none; } }";
d.head.appendChild(s);
})(document);
// delete the temporary CSS (for displaying all slides initially) when the user
// starts to view slides
(function() {
var deleted = false;
slideshow.on('beforeShowSlide', function(slide) {
if (deleted) return;
var sheets = document.styleSheets, node;
for (var i = 0; i < sheets.length; i++) {
node = sheets[i].ownerNode;
if (node.dataset["target"] !== "print-only") continue;
node.parentNode.removeChild(node);
}
deleted = true;
});
})();
(function() {
"use strict"
// Replace <script> tags in slides area to make them executable
var scripts = document.querySelectorAll(
'.remark-slides-area .remark-slide-container script'
);
if (!scripts.length) return;
for (var i = 0; i < scripts.length; i++) {
var s = document.createElement('script');
var code = document.createTextNode(scripts[i].textContent);
s.appendChild(code);
var scriptAttrs = scripts[i].attributes;
for (var j = 0; j < scriptAttrs.length; j++) {
s.setAttribute(scriptAttrs[j].name, scriptAttrs[j].value);
}
scripts[i].parentElement.replaceChild(s, scripts[i]);
}
})();
(function() {
var links = document.getElementsByTagName('a');
for (var i = 0; i < links.length; i++) {
if (/^(https?:)?\/\//.test(links[i].getAttribute('href'))) {
links[i].target = '_blank';
}
}
})();
// adds .remark-code-has-line-highlighted class to <pre> parent elements
// of code chunks containing highlighted lines with class .remark-code-line-highlighted
(function(d) {
const hlines = d.querySelectorAll('.remark-code-line-highlighted');
const preParents = [];
const findPreParent = function(line, p = 0) {
if (p > 1) return null; // traverse up no further than grandparent
const el = line.parentElement;
return el.tagName === "PRE" ? el : findPreParent(el, ++p);
};
for (let line of hlines) {
let pre = findPreParent(line);
if (pre && !preParents.includes(pre)) preParents.push(pre);
}
preParents.forEach(p => p.classList.add("remark-code-has-line-highlighted"));
})(document);</script>
<script>
slideshow._releaseMath = function(el) {
var i, text, code, codes = el.getElementsByTagName('code');
for (i = 0; i < codes.length;) {
code = codes[i];
if (code.parentNode.tagName !== 'PRE' && code.childElementCount === 0) {
text = code.textContent;
if (/^\\\((.|\s)+\\\)$/.test(text) || /^\\\[(.|\s)+\\\]$/.test(text) ||
/^\$\$(.|\s)+\$\$$/.test(text) ||
/^\\begin\{([^}]+)\}(.|\s)+\\end\{[^}]+\}$/.test(text)) {
code.outerHTML = code.innerHTML; // remove <code></code>
continue;
}
}
i++;
}
};
slideshow._releaseMath(document);
</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-MML-AM_CHTML';
if (location.protocol !== 'file:' && /^https?:/.test(script.src))
script.src = script.src.replace(/^https?:/, '');
document.getElementsByTagName('head')[0].appendChild(script);
})();
</script>
</body>
</html>