feedback

Author: audreyyeoCH

slides/05_publication.qmd

@@ -19,7 +19,10 @@ author: Audrey T. Yeo
 ## Setup of `pkgdown`
 
 - `pkgdown` makes it quick and easy to build a website for your package
-- After installing `pkgdown`, run `usethis::use_pkgdown()` to get started
+- After installing `pkgdown`, run `usethis::use_pkgdown()`* to get started
+- Alternatively, run `usethis::use_pkgdown_github_pages()`
+  - 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.
+ 
 - Main configuration happens in `_pkgdown.yml` file
 - Many customizations can be applied, but bulk of work during development is
   updating the `reference` section with names of `.Rd` files
@@ -262,50 +265,62 @@ git diff v0.3.14 v0.3.15 # checking for difference in mmrm release
 - [CRAN Repository Policy](https://cran.r-project.org/web/packages/policies.html)
 - [Bioconductor packages](https://contributions.bioconductor.org/index.html)
 
-# Quick quiz (One correct answer only)
+## Quick quiz (One correct answer only)
 
+::: columns
+::: {.column width="40%"}
 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 ? 
-
 a. MIT Licence
 b. one of any copyleft Licences
 c. no licence assumes transfer of my rights from the original repo
+:::
 
-2. I want to build a website for my package. Which file can I _mainly_ configure my website in ?
+::: {.column width="10%"}
+:::
 
-a. _pkgdown.yml file
+::: {.column width="40%"}
+2. I want to build a website for my package. Which file can I *mainly* configure my website in ? 
+\
+\
+\
+a. `_pkgdown.yml` file
 b. .gitignore
 c. any .Rd file
+:::
+:::
 
-3. What commands do I use to add an MIT licence AND build a `pkgdown` website using github ?
-
-a. `usethis::use_mit_licence()` AND `usethis::use_pkgdown()`
-b. `usethis::use_mit_licence()` AND `usethis::use_pkgdown_github_pages()`
-
-
-# Quick quiz (Solutions)
+## Quick quiz (Solutions) 
 
+::: columns
+::: {.column width="40%"}
 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 ? 
-
 a. **MIT Licence**
 b. one of any copyleft Licences
 c. no licence assumes transfer of my rights from the original repo
+:::
 
-2. I want to build a website for my package. Which file can I *mainly* configure my website in ?
+::: {.column width="10%"}
+:::
 
+::: {.column width="40%"}
+2. I want to build a website for my package. Which file can I *mainly* configure my website in ? 
+\
+\
+\
 a. **`_pkgdown.yml` file**
 b. .gitignore
 c. any .Rd file
-
-3. What commands do I use to add an MIT licence AND build a `pkgdown` website using github ?
-
-a. `usethis::use_mit_licence()` AND `usethis::use_pkgdown()`
-b. **`usethis::use_mit_licence()` AND `usethis::use_pkgdown_github_pages()`**
+:::
+:::
 
 # Exercise
 
 Use the your project from chapter 5 :
 
-- Run CRAN-like checks in RStudio: use `--as-cran` in argument
+- Run CRAN-like checks in RStudio: 
+  - Go to Tools -> Project Options -> Build Tools -> "Check package - R CMD check additional options" : -> type "--as-cran"
+
+- Alternatively, use `--as-cran` in argument in console :
 
 ```{r}
 #| eval: false
@@ -317,7 +332,6 @@ rcmdcheck::rcmdcheck("myrootdir", args = "--as-cran")
 - Enable GitHub page through `use_pkgdown_github_pages`
   - (nested in this [`use_pkgdown_github_pages`](https://pkgdown.r-lib.org/articles/pkgdown.html) includes : `use_pkgdown()`, `use_github_pages()`, `use_github_action("pkgdown")`)
 - Deploy the website with `pkgdown`
-  - Need to change remote to `git` TODO
 - Set up a GitHub action to deploy website `use_github_action("pkgdown")`
   - (Optional) Check the automatic GitHub page deploy action