diff --git a/.Rbuildignore b/.Rbuildignore index b8951c7..b7a387b 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -6,3 +6,4 @@ ^doc$ ^Meta$ ^cran-comments\.md$ +^\.github$ diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/CRAN-RELEASE b/CRAN-RELEASE new file mode 100644 index 0000000..fc23f0d --- /dev/null +++ b/CRAN-RELEASE @@ -0,0 +1,2 @@ +This package was submitted to CRAN on 2021-09-03. +Once it is accepted, delete this file and tag the release (commit 6ae5a07). diff --git a/README.Rmd b/README.Rmd index 0f34177..f5cf6f7 100644 --- a/README.Rmd +++ b/README.Rmd @@ -64,4 +64,4 @@ It might be beneficial to recommend that your students: ## Contributing -Please click [here](CONTRIBUTING.md) for more information on how you can contribute to this project! +Please see `CONTRIBUTING.md` for more information on how you can contribute to this project! diff --git a/README.md b/README.md index 9da152d..1e6ba19 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ # gradeR - The goal of `gradeR` is to help grade bunches of `R` script assignment @@ -58,19 +57,19 @@ file you must create on your own. For more information on how to write It might be beneficial to recommend that your students: - - clear out their workspace and `source` their `.R` submissions before +- clear out their workspace and `source` their `.R` submissions before submitting them. This makes sure everything runs as expected (at least on their machine). - - to not rename files that are read in as data, or change any raw data +- to not rename files that are read in as data, or change any raw data files on *their* hard drives. If they forget to abide by this rule, you will have to edit their submission and rename file names in their script. - - to not use global file paths (have them interactively use `setwd()`, +- to not use global file paths (have them interactively use `setwd()`, and then read in files using only their name). If they forget to do this, then you will need to change all of the global paths to local paths on their machine. ## Contributing -Please click [here](CONTRIBUTING.md) for more information on how you can -contribute to this project\! +Please see `CONTRIBUTING.md` for more information on how you can +contribute to this project! diff --git a/cran-comments.md b/cran-comments.md index f70ffce..e5325e9 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -5,8 +5,7 @@ ## R CMD check results -0 errors | 0 warnings | 1 note +0 errors | 0 warnings | 0 notes * This is an update. -* removed CONTRIBUTING.md from .Rbuildignore so there's no dead link to CONTRIBUTING.md on README.md \ No newline at end of file