You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: slides/05_publication.qmd
+7-8Lines changed: 7 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -19,14 +19,13 @@ author: Audrey T. Yeo
19
19
## Setup of `pkgdown`
20
20
21
21
-`pkgdown` makes it quick and easy to build a website for your package
22
-
- After installing `pkgdown`, run `usethis::use_pkgdown()`* to get started
22
+
- After installing `pkgdown`, run `usethis::use_pkgdown()` to get started
23
23
- Alternatively, run `usethis::use_pkgdown_github_pages()`
24
-
- Adds (and writes) `pkgdown.yml`\*, `docs` folder, and "pkgdown" to `.Rbuildignore`\* and `docs` to `gitignore`\*. Also initialises empty branch `gh-pages` in chosen repo and activates GitHub Pages for repo.
25
-
24
+
- Adds (and writes) `pkgdown.yml`, `docs` folder, and "pkgdown" to `.Rbuildignore` and `docs` to `gitignore`. Also initialises empty branch `gh-pages` in chosen repo and activates GitHub Pages for repo [^1].
26
25
- Main configuration happens in `_pkgdown.yml` file
27
26
- Many customizations can be applied, but bulk of work during development is
28
27
updating the `reference` section with names of `.Rd` files
29
-
28
+
[^1]: `usethis::use_pkgdown_github_pages()` performs these actions additionally to `usethis::use_pkgdown()`.
30
29
31
30
## Example `_pkgdown.yml` File
32
31
@@ -294,9 +293,9 @@ c. any .Rd file
294
293
::: columns
295
294
::: {.column width="40%"}
296
295
1. I am cloning / forking a repo that has an MIT Licence. Which license shall I use if I want to make modification and distribute my new package ?
297
-
a. **MIT Licence**
298
-
b. one of any copyleft Licences
299
-
c. no licence assumes transfer of my rights from the original repo
296
+
a. MIT Licence
297
+
b. **any licence**
298
+
c. no licence because that assumes transfer of my rights from the original repo's MIT Licence
300
299
:::
301
300
302
301
::: {.column width="10%"}
@@ -315,7 +314,7 @@ c. any .Rd file
315
314
316
315
# Exercise
317
316
318
-
Use the your project from chapter 5 :
317
+
Use your project from *chapter 2* :
319
318
320
319
- Run CRAN-like checks in RStudio:
321
320
- Go to Tools -> Project Options -> Build Tools -> "Check package - R CMD check additional options" : -> type "--as-cran"
0 commit comments