Prep to release 0.3.8 to CRAN

.github/workflows/R-CMD-check-daily.yaml

@@ -0,0 +1,58 @@
+# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
+# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
+on:
+  schedule:
+    - cron: "0 7 3 * 0" # Run every morning at 3:07am
+
+name: R-CMD-check-daily
+
+jobs:
+  R-CMD-check-daily:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-pandoc@master
+
+      - name: Query dependencies
+        run: |
+          install.packages('remotes')
+          saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
+          writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
+        shell: Rscript {0}
+
+      - name: Cache R packages
+        if: runner.os != 'Windows'
+        uses: actions/cache@v1
+        with:
+          path: ${{ env.R_LIBS_USER }}
+          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
+          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+
+      - name: Install system dependencies
+        if: runner.os == 'Linux'
+        env:
+          RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
+        run: |
+          Rscript -e "remotes::install_github('r-hub/sysreqs')"
+          sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
+          sudo -s eval "$sysreqs"
+
+      - name: Install dependencies
+        run: |
+          install.packages(c("remotes", "rcmdcheck"))
+          remotes::install_deps(dependencies = TRUE)
+          remotes::install_cran("covr")
+        shell: Rscript {0}
+
+      - name: Check
+        run: |
+          options(crayon.enabled = TRUE)
+          rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
+        shell: Rscript {0}
+
+      - name: Test coverage
+        run: covr::codecov()
+        shell: Rscript {0}

.github/workflows/R-CMD-check-dev.yaml

@@ -0,0 +1,65 @@
+# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
+# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
+on:
+  push:
+    branches:
+      - dev
+      # - main
+      # - master
+  # pull_request:
+  #   branches:
+  #     - main
+  #     - master
+
+name: R-CMD-check-dev
+
+jobs:
+  R-CMD-check-dev:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-pandoc@master
+
+      - name: Query dependencies
+        run: |
+          install.packages('remotes')
+          saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
+          writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
+        shell: Rscript {0}
+
+      - name: Cache R packages
+        if: runner.os != 'Windows'
+        uses: actions/cache@v1
+        with:
+          path: ${{ env.R_LIBS_USER }}
+          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
+          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+
+      - name: Install system dependencies
+        if: runner.os == 'Linux'
+        env:
+          RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
+        run: |
+          Rscript -e "remotes::install_github('r-hub/sysreqs')"
+          sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
+          sudo -s eval "$sysreqs"
+
+      - name: Install dependencies
+        run: |
+          install.packages(c("remotes", "rcmdcheck"))
+          remotes::install_deps(dependencies = TRUE)
+          remotes::install_cran("covr")
+        shell: Rscript {0}
+
+      - name: Check
+        run: |
+          options(crayon.enabled = TRUE)
+          rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
+        shell: Rscript {0}
+
+      - name: Test coverage
+        run: covr::codecov()
+        shell: Rscript {0}

.github/workflows/R-CMD-check-thorough.yaml

@@ -0,0 +1,109 @@
+# NOTE: This workflow is overkill for most R packages
+# check-standard.yaml is likely a better choice
+# usethis::use_github_action("check-standard") will install it.
+#
+# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
+# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
+on:
+  push:
+    branches:
+      - main
+      - master
+      # - dev
+
+  pull_request:
+    branches:
+      - main
+      - master
+
+name: R-CMD-check-thorough
+
+jobs:
+  R-CMD-check-thorough:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macOS-latest,   r: 'release'}
+          - {os: windows-latest, r: 'devel'}
+          - {os: windows-latest, r: 'release'}
+          # - {os: windows-latest, r: '3.6'}
+          - {os: ubuntu-latest,   r: 'devel'}
+          - {os: ubuntu-latest,   r: 'release'}
+          # - {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: ubuntu-18.04,   r: 'oldrel',  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"}
+
+    env:
+      RSPM: ${{ matrix.config.rspm }}
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-r@v1
+        id: install-r
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+
+      - uses: r-lib/actions/setup-pandoc@v1
+
+      - name: Install pak and query dependencies
+        run: |
+          install.packages("pak", repos = "https://r-lib.github.io/p/pak/dev/")
+          saveRDS(pak::pkg_deps("local::.", dependencies = TRUE), ".github/r-depends.rds")
+        shell: Rscript {0}
+
+      - name: Restore R package cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ${{ 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-
+
+      - name: Install system dependencies
+        if: runner.os == 'Linux'
+        run: |
+          pak::local_system_requirements(execute = TRUE)
+          pak::pkg_system_requirements("rcmdcheck", execute = TRUE)
+        shell: Rscript {0}
+
+      - name: Install dependencies
+        run: |
+          pak::local_install_dev_deps(upgrade = TRUE)
+          pak::pkg_install("rcmdcheck")
+        shell: Rscript {0}
+
+      - name: Session info
+        run: |
+          options(width = 100)
+          pkgs <- installed.packages()[, "Package"]
+          sessioninfo::session_info(pkgs, include_base = TRUE)
+        shell: Rscript {0}
+
+      - name: Check
+        env:
+          _R_CHECK_CRAN_INCOMING_: false
+        run: |
+          options(crayon.enabled = TRUE)
+          rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
+        shell: Rscript {0}
+
+      - name: Show testthat output
+        if: always()
+        run: find check -name 'testthat.Rout*' -exec cat '{}' \; || true
+        shell: bash
+
+      - name: Upload check results
+        if: failure()
+        uses: actions/upload-artifact@main
+        with:
+          name: ${{ matrix.config.os }}-r${{ matrix.config.r }}-results
+          path: check

.gitignore

@@ -3,3 +3,5 @@ doc
 Meta
 .Rproj.user
 docs
+/doc/
+/Meta/

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: dataverse
-Version: 0.3.7
+Version: 0.4.0
 Title: Client for Dataverse 4+ Repositories
 Authors@R:
    c(person(given = "Will", 
@@ -61,3 +61,4 @@ VignetteBuilder: knitr
 Encoding: UTF-8
 RoxygenNote: 7.1.1
 Roxygen: list(markdown = TRUE)
+Config/testthat/edition: 3

NEWS.md

@@ -1,12 +1,28 @@
+# CHANGES in dataverse 0.4.0 (2021-04-14 CRAN)
+
+Core Features
+
+* Adapt to Dataverse 5.4.1 (#94 @kuriwaki)
+
+Testing
+
+* Doesn't rely on CRAN for daily tests of API functions (#96)
+* Upgrade testthat to 3.0 edition (#97)
+* Move to GitHub Actions, and away from Travis-CI.  (#98)  Three GitHub Actions are defined for testing: 
+  * thorough testing related to PRs and the main branch,
+  * straight-forward tests for each push to the dev branch, and
+  * straight-forward tests run daily at 3am
+
 # CHANGES in dataverse 0.3.3
+
 * More verbose error messages returned on httr failure. (#31 @EdJeeOnGithub)
 
 # CHANGES in dataverse 0.3.1
 
 * Avoids tests in R Check if the dataverse server is not available (#77)
 * Avoids potential mixup of dataset ordering within a retrieved dataverse (#83)
 
-# CHANGES in dataverse 0.3.0 (2021-01-17, CRAN)
+# CHANGES in dataverse 0.3.0 (2021-01-17 CRAN)
 
 New Methods
 
@@ -22,7 +38,7 @@ Small updates
 * Fix getting multiple files by id in `get_file()` (#47 @adam3smith)
 * Temporary files created by `get_file()` are automatically deleted.
 
-# CHANGES dataverse 0.2.1 (2018-03-05)
+# CHANGES dataverse 0.2.1 (2018-03-05 CRAN)
 
 * Export `initiate_sword_dataset()`. (h/t Justin de Benedictis-Kessner)
 * Pass `key`, `server`, and `...` arguments to internal `get_dataverse()` and `get_dataset()` calls.

R/get_dataset.R

@@ -1,6 +1,6 @@
 #' @rdname get_dataset
 #' @title Get dataset
-#' @description Retrieve a Dataverse dataset or its metadata
+#' @description Retrieve a Dataverse dataset metadata
 #'
 #' @details
 #' \code{get_dataset} retrieves details about a Dataverse dataset.
@@ -14,37 +14,28 @@
 #' \dQuote{dataverse_dataset} objects, whereas \code{\link{get_dataset}} returns
 #' metadata and a data.frame of files (rather than a list of file objects).
 #'
+#' To download actual datafiles, see \code{\link{get_file}} or \code{\link{get_dataframe_by_name}}.
+#'
 #' @template ds
 #' @template version
 #' @template envvars
 #' @template dots
 #' @return A list of class \dQuote{dataverse_dataset} or a list of a form dependent on the specific metadata block retrieved. \code{dataset_files} returns a list of objects of class \dQuote{dataverse_file}.
 #' @examples
 #' \dontrun{
+#' # https://demo.dataverse.org/dataverse/dataverse-client-r
 #' Sys.setenv("DATAVERSE_SERVER" = "demo.dataverse.org")
-#' Sys.setenv("DATAVERSE_KEY"    = "c7208dd2-6ec5-469a-bec5-f57e164888d4")
-#'
-#' # Download file from: https://demo.dataverse.org/file.xhtml?fileId=769385
-#' dv       <- get_dataverse("dataverse-client-r")
-#' contents <- dataverse_contents(dv)
-#'
-#' dataset_files(contents[[1]])            # Dataset contains 2 files
-#' dataset_metadata(contents[[1]])         # Easier to query later
 #'
-#' set      <- get_dataset(contents[[1]])  # 1st dataset w/n dataverse
-#' f        <- get_file(set$files$id[2])   # 2nd file w/n dataset
+#' # download file from:
+#' dv <- get_dataverse("dataverse-client-r")
+#' contents <- dataverse_contents(dv)[[1]]
 #'
-#' # Check the *binary* representation of the file.
-#' length(f)
-#' head(f)
+#' dataset_files(contents[[1]])
+#' get_dataset(contents[[1]])
+#' dataset_metadata(contents[[1]])
 #'
-#' # Examine the plain-text representation.
-#' tmp <- tempfile(fileext = "svg")
-#' writeBin(as.vector(f), tmp)
-#' svg_lines <- readLines(tmp)
-#' head(svg_lines)
 #' }
-#' @seealso \code{\link{create_dataset}}, \code{\link{update_dataset}}, \code{\link{delete_dataset}}, \code{\link{publish_dataset}}, \code{\link{dataset_files}}, \code{\link{dataset_metadata}}
+#' @seealso \code{\link{get_file}}
 #' @export
 get_dataset <- function(
   dataset,