From ce8e6eb97ba4cbc506f5b834fc7b1495c0cab976 Mon Sep 17 00:00:00 2001 From: richardreeve Date: Mon, 28 Nov 2022 11:33:41 +0000 Subject: [PATCH] Update instructions for GitHub repository naming. --- DESCRIPTION | 2 +- inst/tutorials/practical2-1/practical2-1.Rmd | 2 ++ vignettes/pages/github.Rmd | 4 +++- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a4cf6d2b..a6b928b9 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: RPiR Type: Package Title: Reproducible Programming in R -Version: 0.76.12 +Version: 0.76.13 Authors@R: c(person("Sonia", "Mitchell", email = "sonia.mitchell@glasgow.ac.uk", role = c("aut"), comment = c(ORCID = "0000-0003-1536-2066")), diff --git a/inst/tutorials/practical2-1/practical2-1.Rmd b/inst/tutorials/practical2-1/practical2-1.Rmd index 189096b6..2bcbf63d 100644 --- a/inst/tutorials/practical2-1/practical2-1.Rmd +++ b/inst/tutorials/practical2-1/practical2-1.Rmd @@ -68,6 +68,8 @@ documentation pages](https://sbohvm.github.io/RPiR/articles/pages/github.html) that you used for the last practical, putting the repository in the [SBOHVM](https://github.com/SBOHVM) organisation again, as before. Call this project `githubusernameSeries02` (obviously use your real GitHub username!). +Remember that if your GitHub username has dashes or underscores, don't include +them in the repository name however, as they are illegal in R package names. You'll use this single project for all of the exercises in this practical series. If you are already in a coding group, then add the specific people that need to be added to your repository on GitHub in **Settings** -> diff --git a/vignettes/pages/github.Rmd b/vignettes/pages/github.Rmd index d12d2d3c..944d3c78 100644 --- a/vignettes/pages/github.Rmd +++ b/vignettes/pages/github.Rmd @@ -38,7 +38,9 @@ knitr::include_graphics('images/use-github-01.png') You should always choose a short, descriptive name for your repository. But in this case, to make it easier for us to identify you, please include your name as well as an identifier associated with the practical you're working on, e.g. -`githubusernameSeries01`. Make sure you're creating +`githubusernameSeries01`. If your GitHub username has dashes or underscores, +don't include them in the repository name however, as they are illegal in R +package names. Make sure you're creating a Private repository, check the box to Initialize this repository with a README, then select Create repository.