-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
1118 lines (910 loc) · 29.5 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
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
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>r-pkg-slides</title>
<meta charset="utf-8" />
<link href="libs/remark-css-0.0.1/default.css" rel="stylesheet" />
<link href="libs/font-awesome-5.3.1/css/fontawesome-all.min.css" rel="stylesheet" />
<link rel="stylesheet" href="gds.css" type="text/css" />
<link rel="stylesheet" href="gds-fonts.css" type="text/css" />
</head>
<body>
<textarea id="source">
class: title-slide, bottom
.bold[Matt Dray]
<p style="font-size:30px;">
<i class="fab fa-twitter "></i> [@mattdray](https://twitter.com/mattdray) |
<i class="fab fa-github "></i> [matt-dray](https://github.com/matt-dray) |
<i class="fas fa-globe "></i> [rostrum.blog](https://www.rostrum.blog/)
<p>
<p style="font-size:20px;">
<i class="fas fa-info "></i>
[Blog post](https://www.rostrum.blog/2019/11/01/usethis/) |
[Slide source](https://github.com/matt-dray/r-pkg-slides) |
[Session details](https://co-analysis.github.io/co-coffee-and-coding/session_2019-11-01_r-package-usethis.html)
<p>
<p style="font-size:20px;">
<i class="fas fa-keyboard "></i> Press &#8592; &#8594; to navigate, P for presenter notes, F for full screen
<p>
---
class: inverse, middle
Easier R packages with {usethis}
???
* What do I mean by easy?
* You can write the whole thing from scratch, which uses multiple files and languages
* Or you can use some shortcuts thanks to some packages
---
class: middle
📦
Goal: create an R package quickly and simply with {usethis}
---
class: middle
Some useful tutorials:
* Hilary Parker's [post](https://hilaryparker.com/2014/04/29/writing-an-r-package-from-scratch/)
* Tomas Westlake's [update](https://r-mageddon.netlify.com/post/writing-an-r-package-from-scratch/)
* Emil Hvitfeldt’s {usethis} [post](https://www.hvitfeldt.me/blog/usethis-workflow-for-package-development/)
* Karl Broman's [site](https://kbroman.org/pkg_primer/)
* Hadley Wickham's [book](http://r-pkgs.had.co.nz/)
---
class: middle
But first: name these cats
<center><img src='img/cat_tweet.png'></center>
???
* Ossie (left) and Evie (right): the Cabinet Office cats
* It will become obvious why I've mentioned this
---
class: middle
🙋
Who has:
* used R?
* written a function?
* written a package?
---
class: inverse, middle
Let's get #deep
---
class: middle
What _is_ a function?
Why make one?
???
* A command that does a thing, like `read.csv()`
* Provide arguments to inform its behaviour, like `read.csv(file = "data.csv")`
* Prevents you repeating yourself and abstracts away a bunch of code
* You can write your own functions with the `function() {}` syntax
---
class: middle
What _is_ a package?
Why make one?
???
* A collection of functions (usually)
* Practically, it's a folder containing code, documentation and some other special files in a particular format
* Themed to perform certain type of task (usually), like plotting
* Shareable (via a GitHub repository, published on CRAN, or even as a zipped folder)
* You can write your own packages, but
---
class: inverse, middle
background-image: url("img/hex_small.jpg")
background-size: cover
???
* Some packages are built into R already; you can install more
* Examples: {readr} to read files, {parsnip} for model fitting, {xaringan} to create slides
* Image by Amelia McNamara
---
class: inverse, middle
Minimal package example
???
* Let's build a simple, (nearly) pointless package to illustrate the process
* It's going to start out _very_ simple; just a single function
* It won't even have full documentation, but we'll add it later
---
class: middle
Packages to help make packages
```r
install.packages("devtools", "usethis")
library(devtools)
library(usethis)
```
<center><img src="img/devtools.svg" width=200><img src="img/usethis.png" width=200></center>
???
* {devtools} is a general purpose package for developing packages
* {usethis} is a package of functions for setting up your own package
---
class: middle
Create package folder and files 🆕
```r
usethis::create_package("~/Desktop/cabinet")
# ✔ Setting active project to '/Users/matthewdray/Desktop/cabinet'
*# ✔ Creating 'R/'
*# ✔ Creating 'man/'
*# ✔ Writing 'DESCRIPTION'
*# ✔ Writing 'NAMESPACE'
# ✔ Writing 'cabinet.Rproj'
# ✔ Adding '.Rproj.user' to '.gitignore'
# ✔ Adding '^cabinet\\.Rproj$', '^\\.Rproj\\.user$' to '.Rbuildignore'
*# ✔ Opening new project 'cabinet' in RStudio
```
???
* A package is a folder containing a bunch of files; `create_package()` creates these for you
* Some of the files contain the functions, other files are for documentation, for example
* If you run the line from within RStudio, it automatically creates an RStudio (.Rproj) file for your new package and opens it
* I'm using the `package::function()` convention throughout so you know what package each function is from
---
class: middle
The resulting file structure
```r
cabinet/
├── man/
* ├── R/
├── cabinet.Rproj
* ├── DESCRIPTION
└── NAMESPACE
```
???
* This is the basic package folder skeleton created by `create_package()`
* We can add to/edit `R/` and `DESCRIPTION`
# `R/` is where our function scripts will go
* `DESCRIPTION` is where information about the package goes
* Don't touch `man/` and `NAMESPACE`; we can use functions later to fill these for us
* `man/` is where documentation (in a special format) will live
* `NAMESPACE` is a sort-of 'lookup' for object names
* There were some hidden files added too (`.gitignore` and `.buildignore` that we don't need to worry about now)
---
class: middle
Create a script file for functions
```r
usethis::use_r("felines")
# ● Modify 'R/felines.R'
```
???
* Obviously we need to add functions to our package
* They go in R script files in the `R/` folder
* `use_r()` creates a script file with the provided string argument as its name
* It will open automatically in RStudio
* You would typically create multiple script files, where functions with the same 'theme' go in the same script file
---
class: middle
Script added to `R/`!
```r
cabinet/
├── man/
├── R/
* | └── felines.R
├── cabinet.Rproj
├── DESCRIPTION
└── NAMESPACE
```
---
class: middle
Add functions to `R/felines.R` 👨💻
```r
cabinet_cat <- function(name) {
stopifnot(is.character(name))
if (name %in% c("Ossie", "Evie")) {
print(paste(name, "is a good Cabinet Office kitty."))
} else if (name %in% c("Palmerston", "Larry", "Gladstone")) {
print(paste(name, "isn't a Cabinet Office cat!"))
} else {
print("You've much to learn about government cats.")
}
}
```
???
* Just going to add one silly one now
* This isn't function-writing best practice, but will do for now
* What does this function do?
---
class: middle
Document it 📝
```r
devtools::document()
# Updating cabinet documentation
# Updating roxygen version in /Users/matthewdray/Desktop/cabinet/DESCRIPTION
*# Writing NAMESPACE
# Loading cabinet
```
???
* The only real change here is the addition of the function to the `NAMESPACE`
* Which allows the function to be exposed to the user
---
class: middle
Use the function! 🐈
```r
cabinet_cat("Ossie")
# Ossie is a good Cabinet Office kitty.
cabinet_cat("Gladstone")
# Gladstone isn't a Cabinet Office cat!
cabinet_cat("Garfield")
# You've much to learn about government cats.
```
???
* We could stop here, but this isn't that useful
* What's missing?
* Obviously more functions, but also the documentation for them
* People can't use the functions if they don't know what they do or how to use them
---
class: inverse, middle
Add internal documentation
???
* What do I mean by internal documentation?
* I mean the documentation that can be accessed throgh the package with `help(function)` or `?function`
---
class:middle
Basic approach:
1. Write text in certain places
1. Run `devtools::document()`
1. `.Rd` file generated
1. Call `?function_name` as needed
---
class: middle
Add documentation for:
* the package by editing `DESCRIPTION`
* each function by editing `.R` files
---
class: middle
Edit the `DESCRIPTION`
```r
Package: cabinet
*Title: A Package To Show How To Create Packages
Version: 0.0.0.9000
*Authors@R:
* person(given = "Matt",
* family = "Dray",
* role = c("aut", "cre"),
* email = "matthew.dray@digital.cabinet-office.gov.uk")
*Description: A package created for a Cabinet Office Coffee & Coding
* session that doesn't do anything useful in particular.
License: What license it uses
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.1
```
???
* The `DESCRIPTION` file describes the package: what, who, etc
* You can adapt and add to this template
* For now, just update the highlighted lines
* This will be turned into documentation that will say what the package does
---
class: middle
Start documenting the package by altering the `DESCRIPTION`
```r
usethis::use_package_doc()
# ✔ Writing 'R/cabinet-package.R'
devtools::document()
# Updating cabinet documentation
# Loading cabinet
*# Writing cabinet-package.Rd
```
---
class: middle
An `.Rd` was generated in `man/`!
```r
cabinet/
├── man/
* | └── cabinet-package.Rd
├── R/
* | ├── cabinet-package.R
| └── felines.R
├── cabinet.Rproj
├── DESCRIPTION
└── NAMESPACE
```
???
* .Rd files are the ones that R interprets as documentation
* These are generated when we run `devtools::document()`
* It turns the format of the `DESCRIPTION` file into the format in an `.Rd`
---
class: middle
A peek at the `.Rd` file
```r
*% Generated by roxygen2: do not edit by hand
*% Please edit documentation in R/cabinet-package.R
\docType{package}
\name{cabinet-package}
\alias{cabinet}
\alias{cabinet-package}
\title{cabinet: A Package To Show How To Create Packages}
\description{
A package created for a Cabinet Office Coffee & Coding
session that doesn't do anything useful in particular.
}
\author{
\strong{Maintainer}: Matt Dray \email{matthew.dray@digital.cabinet-office.gov.uk}
}
\keyword{internal}
```
???
* It would've been a pain to write this by hand
* The `.Rd` extension is 'roxygen documentation'
* It's in a kind of LaTeX implementation
* This is what the `DESCRIPTION` file was converted to so it can be rendered as a help page
---
class: middle
Add roxygen comments above functions
```r
#' @title Check For A Cabinet Office Cat
#' @description Check whether a name belongs to one of the cats from the UK
#' government's Cabinet Office.
*#' @param name A cat name provided as a character string.
*#' @export
#' @examples
#' cabinet_cat("Evie")
cabinet_cat <- function(name) {
stopifnot(is.character(name))
if (name %in% c("Ossie", "Evie")) {
print(paste(name, "is a good Cabinet Office kitty."))
} else if (name %in% c("Palmerston", "Larry", "Gladstone")) {
print(paste(name, "isn't a Cabinet Office cat!"))
} else {
print("You've much to learn about government cats.")
}
}
```
???
* Add these lines above the function in `R/felines.R`
* Possibly the trickiest part of the process, because you may not have seen roxygen before
* Special comment block (`#'`) followed by `@thing` to provide info about the function
* Includes title (`@title`), description (`@description`), the arguments (`@param`), etc
* `@export` is included so that the function is made available to package users (yes, you can have internal package functions that are never exposed to a user!)
* Other sections that can be added, but we won't worry about those now
---
class: middle
And `document()` again
```r
devtools::document()
# Updating cabinet documentation
# Loading cabinet
# Writing NAMESPACE
*# Writing cabinet_cat.Rd
```
---
class: middle
The roxygen was also converted to `.Rd`
```r
cabinet/
├── man/
| ├── cabinet-package.Rd
* | └── cabinet_cat.Rd
├── R/
| ├──cabinet-package.R
| └── felines.R
├── cabinet.Rproj
├── DESCRIPTION
└── NAMESPACE
```
---
class: middle
Now you can see documentation
```r
?cabinet_cat
# Rendering development documentation for 'cabinet_cat'
```
<center><img src="img/cabinet_cat_docs.png" width=500></center>
???
* This will appear in the 'help' pane of RStudio
* Now people can see what the function is for
* And see what the arguments are and how to use it
---
class: inverse, middle
Add longer-form documentation
???
* A README (general package introduction, how to install, etc; useful for GitHub landing page)
* Focussed vignettes to explain how to do particular tasks
---
class: middle
Add a README 📝
```r
usethis::use_readme_md()
# ✔ Writing 'README.md'
*# ● Modify 'README.md'
```
???
* This is added to the project home directory
* It's partially pre-filled to give you an idea of what the content should be
* File will open automatically in RStudio for editing
* I've called this 'external' because it gets rendered nicely as a sort of 'homepage' for the package on GitHub
---
class: middle
Add walkthrough vignettes
```r
usethis::use_vignette("Check cat names")
*# ✔ Adding 'knitr' to Suggests field in DESCRIPTION
# ✔ Setting VignetteBuilder field in DESCRIPTION to 'knitr'
*# ✔ Adding 'rmarkdown' to Suggests field in DESCRIPTION
# ✔ Creating 'vignettes/'
# ✔ Adding '*.html', '*.R' to 'vignettes/.gitignore'
# ✔ Adding 'inst/doc' to '.gitignore'
# ✔ Creating 'vignettes/check-cat-names.Rmd'
*# ● Modify 'vignettes/check-cat-names.Rmd'
```
???
* This creates an R Markdown file in `vignettes/`
* Adds packages for rendering the R Markdown file to 'Suggests' in the `DESCRIPTION`
* File will open automatically in RStudio for editing
* Vignettes are arguably 'internal', but we're going to expose them on the internet
---
class: middle
You guessed it
```r
devtools::document()
# Updating cabinet documentation
# Writing NAMESPACE
# Loading cabinet
# Writing NAMESPACE
```
---
class: middle
The new documentation will help people use the package
```r
cabinet/
├── man/
| ├── cabinet-package.Rd
| └── cabinet_cat.Rd
├── R/
| ├── cabinet-package.R
| └── felines.R
* ├── vignettes/
* | └── check-cat-names.Rmd
├── cabinet.Rproj
├── DESCRIPTION
├── NAMESPACE
* └── README.md
```
---
class: inverse, middle
Add packages to your package
???
* I only used base functions in the package
* What if I want to refer to functions from other packages?
---
class: middle
Let's use {glue} instead of `paste()`
```r
cabinet_cat <- function(name) {
stopifnot(is.character(name))
if (name %in% c("Ossie", "Evie")) {
* print(glue::glue("{name} is a good Cabinet Office kitty."))
} else if (name %in% c("Palmerston", "Larry", "Gladstone")) {
* print(glue::glue("{name} isn't a Cabinet Office cat!"))
} else {
print("You've much to learn about government cats.")
}
}
```
???
* Use the `package::function` convention
---
class: middle
Add {glue} to the package
```r
usethis::use_package("glue")
*# ✔ Adding 'glue' to Imports field in DESCRIPTION
# ● Refer to functions with `glue::fun()`
```
---
Package name added to 'Imports' in `DESCRIPTION`
```r
Package: cabinet
Title: A Package To Show How To Create Packages
Version: 0.0.0.9000
Authors@R:
person(given = "Matt",
family = "Dray",
role = c("aut", "cre"),
email = "matthew.dray@digital.cabinet-office.gov.uk")
Description: A package created for a Cabinet Office Coffee & Coding
session that doesn't do anything useful in particular.
License: What license it uses
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.1
*Imports:
* glue
```
???
* So {glue} wil be installed when {cabinet} is installed
* If the package isn't on CRAN, you can use 'Remotes' instead of 'Imports'
* You don't always want to install things on someone else's machine
* You can use 'Suggests' to suggest packages instead
* {testthat} is often suggested because it's not usually used in user-facing functions
---
class: inverse, middle
Test your functions
???
* This session isn't about testing
* But you can set up testing for your files quickly with {usethis}
* You want to make sure that your functions behave as intended
---
class: middle
Create directory structure for {testhat}
```r
usethis::use_testthat()
*# ✔ Adding 'testthat' to Suggests field in DESCRIPTION
*# ✔ Creating 'tests/testthat/'
# ✔ Writing 'tests/testthat.R'
```
Create a test file
```r
usethis::use_test("felines")
# ✔ Writing 'tests/testthat/test-felines.R'
*# ● Modify 'tests/testthat/test-felines.R'
```
???
* {testthat} is a package for writing tests
* Group your tests into logical groups
* We've only got one function to test right now
* The new test file opens automatically
---
class: middle
Add a test to `R/test-felines.R` ✅
```r
context("test-felines")
test_that("numeric input causes error", {
expect_error(cabinet::cabinet_cat(1))
})
```
???
* What do you think this test does?
* Write more tests to cover as many possibilities as possible
* And to cover as much of the code as possible
---
class: middle
Run the tests 🆗
```r
devtools::test()
# Loading cabinet
# Testing cabinet
# ✔ | OK F W S | Context
# ✔ | 1 | test-felines [0.1 s]
#
# ══ Results ═════════════════════════════════
# Duration: 0.1 s
#
# OK: 1
# Failed: 0
# Warnings: 0
# Skipped: 0
```
---
class: middle
Here's what the package section of the `DESCRIPTION` looks like now
```r
*Suggests:
* knitr,
* rmarkdown,
* testthat
*VignetteBuilder: knitr
Imports:
glue
```
---
class: inverse, middle
Share the package
???
* This session isn't about Git and GitHub
* But we can put the package under version control and add it to GitHub
* All without writing any Git code and with minimal navigation of GitHub
* Requires a GitHub account
---
class: middle
Add a license and code of conduct for interacting with your package
```r
usethis::use_cc0_license("Matt Dray")
# ✔ Setting License field in DESCRIPTION to 'CC0'
*# ✔ Writing 'LICENSE.md'
# ✔ Adding '^LICENSE\\.md$' to '.Rbuildignore'
```
```r
usethis::use_code_of_conduct()
# ✔ Writing 'CODE_OF_CONDUCT.md'
# ✔ Adding '^CODE_OF_CONDUCT\\.md$' to '.Rbuildignore'
*# ● Don't forget to describe the code of conduct in your README:
# Copying code to clipboard:
# Please note that the 'cabinet' project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
```
???
* If we're going to share our package, we should set a license and a code of conduct
* License so people know how to reuse our code
* Code of conduct so people know how to behave
---
class: middle
Initiate Git, make first commit
```r
usethis::use_git()
# ✔ Initialising Git repo
# ✔ Adding '.Rhistory', '.RData' to '.gitignore'
*# OK to make an initial commit of 8 files?
# 1: Yes
# 2: No way
# 3: Absolutely not
Selection: 1
# ✔ Adding files and committing
# ● A restart of RStudio is required to activate the Git pane
# ● Restart now?
# 1: Not now
# 2: Negative
# 3: Yup
Selection: 3
```
???
* Can do `usethis::use_git_ignore(".DS_Store")` to add stuff to gitignore
---
class: middle
Configure a Personal Access Token to access the GitHub API 🎫
```r
usethis::browse_github_pat()
# ✔ Opening URL https://github.com/settings/tokens/new?scopes=repo,gist&description=R:GITHUB_PAT
# ● Call `edit_r_environ()` to open '.Renviron' and store your PAT with a line like:
# GITHUB_PAT=xxxyyyzzz
# ● Make sure '.Renviron' ends with a newline!
usethis::edit_r_environ()
# ● Modify '/Users/matthewdray/.Renviron'
# ● Restart R for changes to take effect
```
???
* I've already added a PAT to my `.Renviron`
---
class: middle
Push the package to GitHub ☁️
```r
usethis::use_github(protocol = "https")
# ● Check title and description
# Name: cabinet
# Description: A Package To Show How To Create Packages
*# Are title and description ok?
# 1: Not now
# 2: Definitely
# 3: No way
Selection: 2
*# ✔ Creating GitHub repository
# ✔ Adding GitHub remote
*# ✔ Adding GitHub links to DESCRIPTION
*# ✔ Setting URL field in DESCRIPTION to 'https://github.com/matt-dray/cabinet'
# ✔ Setting BugReports field in DESCRIPTION to 'https://github.com/matt-dray/cabinet/issues'
# ✔ Pushing to GitHub and setting remote tracking branch
# ✔ Opening URL https://github.com/matt-dray/cabinet
```
---
class: middle
<img src="img/github_repo.png">
---
class: middle
Now it's available to everyone! 🎉
```r
install.packages("remotes")
remotes::install_github("matt-dray/cabinet")
```
???
* {remotes} contains functions for installing packages from remote sources (e.g. GitHub)
* Supply a string in the form `"username/package"`
* You can also use it to install from local sources (i.e. a package folder on your machine)
---
class: inverse, middle
Publicise!
---
class: middle
Install {pkgdown} for website
```r
install.packages("pkgdown")
library(pkgdown)
```
<center><img src="img/pkgdown.png" width=200></center>
???
* The ultimate external reference for your package
* Your documented files are spun into a website that you can host on github.io from a GitHub repo, for example
---
class: middle
Generate website files in `docs/`
```r
pkgdown::build_site()
# ── Installing package into temporary library ──────────────────────────────────────
# ══ Building pkgdown site ══════════════════════════════════════════════════════════
# Reading from: '/Users/matthewdray/Desktop/cabinet'
# Writing to: '/Users/matthewdray/Desktop/cabinet/docs'
# ── Initialising site ──────────────────────────────────────────────────────────────
# Copying '../../../../Library/Frameworks/R.framework/Versions/3.5/Resources/library/pkgdown/assets/docsearch.css' to 'docsearch.css'
#
# [truncated]
#
# ── Building articles ──────────────────────────────────────────────────────────────
# Writing 'articles/index.html'
# Reading 'vignettes/check-cat-names.Rmd'
# Writing 'articles/check-cat-names.html'
# ══ DONE ═══════════════════════════════════════════════════════════════════════════
# ── Previewing site ────────────────────────────────────────────────────────────────
```
---
class: middle
Push changes and go to repo settings
<center><img src="img/github_io.png" width = 600><center>
---
class: middle
We have a live website 🍾
<center><img src="img/cabinet_pkgdown.png" width=600><center>
---
class: inverse, middle
Recap
---
class: middle
So, we:
1. Created a package from scratch
1. Documented it internally
1. Wrote some long-form documentation
1. Set up tests
1. Set up version control
1. Made it available openly on GitHub
1. Built a website for it
---
class: middle
Final folder structure
```r
cabinet/
├── .gitignore
├── .buildignore
├── cabinet.Rproj
* ├── DESCRIPTION
├── docs/
* ├── man/
* ├── NAMESPACE
* ├── R/
├── tests/
├── README.md
└── vignettes/
```
???
* This grew from the basic `DESCRIPTION`, `NAMESPACE`, `R/` and `man/`
* But we didn't really have to think about it; we used {usethis} to help
---
Class: middle
You can:
* find the package [on GitHub](https://github.com/matt-dray/cabinet)
* look at [the package website](https://matt-dray.github.io/cabinet/)
* install the package and run the function with:
```{reval=FALSE}
remotes::install_github("matt-dray/cabinet")`
cabinet::cabinet_cat("Ossie")
```
---
class: title-slide, bottom
.bold[Thanks!]
<br>
<p style="font-size:30px;">
<i class="fab fa-twitter "></i> [@mattdray](https://twitter.com/mattdray) |
<i class="fab fa-github "></i> [matt-dray](https://github.com/matt-dray) |
<i class="fas fa-globe "></i> [rostrum.blog](https://www.rostrum.blog/)
<p>
<p style="font-size:20px;">
<i class="fas fa-info "></i>
[Blog post](https://www.rostrum.blog/2019/11/01/usethis/) |
[Slide source](https://github.com/matt-dray/r-pkg-slides) |
[Session details](https://co-analysis.github.io/co-coffee-and-coding/session_2019-11-01_r-package-usethis.html)
<p>
</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>var slideshow = remark.create({
"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 +"; }";