Dry-run of CRAN release (#251)

* Polish cran_comments.md * Update GH actions workflow for R CMD check * All exported functions now have return and value * Polish internal documentation * Avoid problems with URLs urlchecker::url_check(): ✖ Error: README.md:14:59 404: Not Found status](https://www.r-pkg.org/badges/version/r2dii.plot)](https://CRAN.R-project.org/package=r2dii.plot) ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Re-build README.Rmd Co-authored-by: GitHub Actions <actions@github.com>
RMI-PACTA · Jun 10, 2021 · 5535d54 · 5535d54
1 parent bb8b042
commit 5535d54
Show file tree

Hide file tree

Showing 25 changed files with 126 additions and 61 deletions.
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -28,10 +28,11 @@ jobs:
         config:
           - {os: macOS-latest,   r: 'release'}
           - {os: windows-latest, r: 'release'}
-          - {os: windows-latest, r: '3.6'}
-          - {os: ubuntu-18.04,   r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest", http-user-agent: "R/4.0.0 (ubuntu-18.04) R (4.0.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
+          - {os: windows-latest, r: '3.6', rspm: "https://packagemanager.rstudio.com/cran/latest"}
+          - {os: ubuntu-18.04,   r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest", http-user-agent: "R/4.1.0 (ubuntu-18.04) R (4.1.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
           - {os: ubuntu-18.04,   r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
           - {os: ubuntu-18.04,   r: 'oldrel',  rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
+          - {os: ubuntu-18.04,   r: '3.6',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
           - {os: ubuntu-18.04,   r: '3.5',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
           - {os: ubuntu-18.04,   r: '3.4',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
 
@@ -60,7 +61,7 @@ jobs:
         uses: actions/cache@v2
         with:
           path: |
-            ${{ env.R_LIBS_USER }}
+            ${{ env.R_LIBS_USER }}/*
             !${{ env.R_LIBS_USER }}/pak
           key: ${{ matrix.config.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-${{ hashFiles('.github/r-depends.rds') }}
           restore-keys: ${{ matrix.config.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-
@@ -104,3 +105,8 @@ jobs:
         with:
           name: ${{ matrix.config.os }}-r${{ matrix.config.r }}-results
           path: check
+
+      - name: Don't use tar from old Rtools to store the cache
+        if: ${{ runner.os == 'Windows' && startsWith(steps.install-r.outputs.installed-r-version, '3.6' ) }}
+        shell: bash
+        run: echo "C:/Program Files/Git/usr/bin" >> $GITHUB_PATH
diff --git a/R/colours.R b/R/colours.R
diff --git a/R/plot_techmixX.R b/R/plot_techmixX.R
@@ -7,12 +7,12 @@
 #'   * The column `metric` must have a portfolio (e.g. "projected"), a benchmark
 #'   (e.g. "corporate_economy"), and a single `scenario` (e.g. "target_sds").
 #'
-#' @return A "ggplot".
-#' @export
-#'
 #' @family functions with minimal arguments
 #' @seealso [market_share].
 #'
+#' @return An object of class "ggplot".
+#'
+#' @export
 #' @examples
 #' library(dplyr, warn.conflicts = FALSE)
 #'

diff --git a/R/plot_techmixY.R b/R/plot_techmixY.R
@@ -15,6 +15,8 @@
 #'
 #' @family plotting functions
 #'
+#' @return An object of class "ggplot".
+#'
 #' @export
 #' @examples
 #' data <- prep_techmixY(

diff --git a/R/plot_timelineX.R b/R/plot_timelineX.R
@@ -6,12 +6,12 @@
 #' @inheritParams prep_timelineY
 #' @inheritParams plot_timelineY
 #'
-#' @return A "ggplot".
-#' @export
-#'
 #' @family functions with minimal arguments
 #' @seealso [sda].
 #'
+#' @return An object of class "ggplot".
+#'
+#' @export
 #' @examples
 #' library(dplyr, warn.conflicts = FALSE)
 #'

diff --git a/R/plot_timelineY.R b/R/plot_timelineY.R
@@ -15,6 +15,7 @@
 #' allows custom recoding via a data frame passed to the argument `specs`.
 #'
 #' @seealso [sda], [timeline_specs].
+#'
 #' @return An object of class "ggplot".
 #'
 #' @export

diff --git a/R/plot_trajectoryX.R b/R/plot_trajectoryX.R
@@ -10,12 +10,12 @@
 #' @inheritParams prep_trajectoryY
 #' @inheritParams prep_timelineY
 #'
-#' @return A "ggplot".
-#' @export
-#'
 #' @family functions with minimal arguments
 #' @seealso [market_share].
 #'
+#' @return An object of class "ggplot".
+#'
+#' @export
 #' @examples
 #' library(dplyr, warn.conflicts = FALSE)
 #'

diff --git a/R/plot_trajectoryY.R b/R/plot_trajectoryY.R
@@ -23,6 +23,8 @@
 #'
 #' @family plotting functions
 #'
+#' @return An object of class "ggplot".
+#'
 #' @export
 #' @examples
 #' data <- prep_trajectoryY(

diff --git a/R/prep_techmixY.R b/R/prep_techmixY.R
@@ -9,6 +9,8 @@
 #' @param scenario_filter String of length 1. Scenario to pick from the `data`.
 #' @inheritParams prep_timelineY
 #'
+#' @return An object of class "ggplot".
+#'
 #' @export
 #' @examples
 #' prep_techmixY(

diff --git a/R/prep_timelineY.R b/R/prep_timelineY.R
@@ -12,8 +12,8 @@
 #' @seealso [sda].
 #'
 #' @return Data frame with columns: year, line_name, value, extrapolated.
-#' @export
 #'
+#' @export
 #' @examples
 #' library(dplyr, warn.conflicts = FALSE)
 #'

diff --git a/R/r2dii_colours.R b/R/r2dii_colours.R
@@ -0,0 +1,32 @@
+#' Colour datasets
+#'
+#' All datasets have at least two columns:
+#' * `label`: Text label of the colour.
+#' * `hex`: Hex code of the colour.
+#'
+#' In `scenario_colours`, colours are ordered from red to green to be used in
+#' trajectory charts.
+#'
+#' @name r2dii_colours
+#' @keywords internal
+#'
+#' @examples
+#' r2dii.plot:::palette_colours
+#'
+#' r2dii.plot:::scenario_colours
+#'
+#' r2dii.plot:::sector_colours
+#'
+#' r2dii.plot:::technology_colours
+#'
+NULL
+
+#' @rdname r2dii_colours
+"palette_colours"
+#' @rdname r2dii_colours
+"scenario_colours"
+#' @rdname r2dii_colours
+"sector_colours"
+#' @rdname r2dii_colours
+"technology_colours"
+
diff --git a/R/theme_2dii.R b/R/theme_2dii.R
@@ -8,6 +8,7 @@
 #' @family plotting functions
 #'
 #' @return An object of class `r toString(class(theme_2dii()))`.
+#'
 #' @export
 #' @examples
 #' library(ggplot2, warn.conflicts = FALSE)

diff --git a/R/timeline_specs.R b/R/timeline_specs.R
@@ -3,7 +3,9 @@
 #' @inheritParams plot_timelineY
 #'
 #' @seealso plot_timelineA
+#'
 #' @return A data frame useful as the `specs` argument of [plot_timelineY()].
+#'
 #' @export
 #' @examples
 #' data <- prep_timelineY(sda, sector_filter = "cement")

diff --git a/README.Rmd b/README.Rmd
@@ -21,7 +21,6 @@ knitr::opts_chunk$set(
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
 [![Codecov test coverage](https://codecov.io/gh/2DegreesInvesting/r2dii.plot/branch/master/graph/badge.svg)](https://codecov.io/gh/2DegreesInvesting/r2dii.plot?branch=master)
 [![R-CMD-check](https://github.com/2DegreesInvesting/r2dii.plot/workflows/R-CMD-check/badge.svg)](https://github.com/2DegreesInvesting/r2dii.plot/actions)
-[![CRAN status](https://www.r-pkg.org/badges/version/r2dii.plot)](https://CRAN.R-project.org/package=r2dii.plot)
 <!-- badges: end -->
 
 ```{r echo=FALSE}

diff --git a/README.md b/README.md
@@ -10,8 +10,6 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
 [![Codecov test
 coverage](https://codecov.io/gh/2DegreesInvesting/r2dii.plot/branch/master/graph/badge.svg)](https://codecov.io/gh/2DegreesInvesting/r2dii.plot?branch=master)
 [![R-CMD-check](https://github.com/2DegreesInvesting/r2dii.plot/workflows/R-CMD-check/badge.svg)](https://github.com/2DegreesInvesting/r2dii.plot/actions)
-[![CRAN
-status](https://www.r-pkg.org/badges/version/r2dii.plot)](https://CRAN.R-project.org/package=r2dii.plot)
 <!-- badges: end -->
 
 The goal of r2dii.plot is to help you plot 2DII data in an informative,

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,7 +1,7 @@
 ## Test environments
 
-* ubuntu 18.04 (local), R 4.0.3
-* ubuntu 16.04 (github actions), R-oldrel, R-release, R-devel
+* ubuntu 18.04 (local), R 4.1.0
+* ubuntu 18.04 (github actions), R-oldrel, R-release, R-devel
 * macOS-latest (github actions), R-release
 * windows-latest (github actions), R-oldrel, R-release
 * win-builder, R-release, R-devel

diff --git a/data-raw/colours.R → data-raw/r2dii_colours.R b/data-raw/colours.R → data-raw/r2dii_colours.R
diff --git a/man/palette_colours.Rd b/man/palette_colours.Rd
diff --git a/man/plot_techmixX.Rd b/man/plot_techmixX.Rd
diff --git a/man/plot_techmixY.Rd b/man/plot_techmixY.Rd
diff --git a/man/plot_timelineX.Rd b/man/plot_timelineX.Rd
diff --git a/man/plot_trajectoryX.Rd b/man/plot_trajectoryX.Rd
diff --git a/man/plot_trajectoryY.Rd b/man/plot_trajectoryY.Rd
diff --git a/man/prep_techmixY.Rd b/man/prep_techmixY.Rd
diff --git a/man/r2dii_colours.Rd b/man/r2dii_colours.Rd