Skip to content

Commit

Permalink
Merge pull request #24 from jasenfinch/devel
Browse files Browse the repository at this point in the history
v0.6.0
  • Loading branch information
jasenfinch committed Feb 23, 2023
2 parents 4ad7bea + 8e26595 commit e89c442
Show file tree
Hide file tree
Showing 57 changed files with 444 additions and 3,917 deletions.
86 changes: 20 additions & 66 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
# 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
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches:
- main
- master
- devel
branches: [main, master, devel]
pull_request:
branches:
- main
- master
schedule:
- cron: '0 0 * * *'
branches: [main, master]

name: R-CMD-check

Expand All @@ -25,71 +18,32 @@ jobs:
fail-fast: false
matrix:
config:
- {os: macos-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: macOS-latest, r: 'release'}
- {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
- {os: ubuntu-20.04, r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}

env:
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
RSPM: ${{ matrix.config.rspm }}
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-r@v1
- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
r-version: ${{ matrix.config.r }}
http-user-agent: ${{ matrix.config.http-user-agent }}
use-public-rspm: true

- uses: r-lib/actions/setup-pandoc@v1

- 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@v2
- uses: r-lib/actions/setup-r-dependencies@v2
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'
run: |
while read -r cmd
do
eval sudo $cmd
done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "20.04"))')
- name: Install dependencies
run: |
remotes::install_deps(dependencies = TRUE)
remotes::install_cran(c("rcmdcheck","goodpractice"))
shell: Rscript {0}

- name: Check
env:
_R_CHECK_CRAN_INCOMING_REMOTE_: false
run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
shell: Rscript {0}

- name: Good practice
run: goodpractice::goodpractice()
shell: Rscript {0}

- name: Test coverage
run: covr::codecov()
shell: Rscript {0}
extra-packages: any::rcmdcheck
needs: check

- name: Upload check results
if: failure()
uses: actions/upload-artifact@main
- uses: r-lib/actions/check-r-package@v2
with:
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
path: check
upload-snapshots: true
46 changes: 46 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
release:
types: [published]
workflow_dispatch:

name: pkgdown

jobs:
pkgdown:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::.
needs: website

- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@v4.4.1
with:
clean: false
branch: gh-pages
folder: docs
50 changes: 50 additions & 0 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]

name: test-coverage

jobs:
test-coverage:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::covr
needs: coverage

- name: Test coverage
run: |
covr::codecov(
quiet = FALSE,
clean = FALSE,
install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
)
shell: Rscript {0}

- name: Show testthat output
if: always()
run: |
## --------------------------------------------------------------------
find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
shell: bash

- name: Upload test results
if: failure()
uses: actions/upload-artifact@v3
with:
name: coverage-test-failures
path: ${{ runner.temp }}/package
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
.Ruserdata
the_test
test
docs
18 changes: 9 additions & 9 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
Package: projecttemplates
Title: Project Templates for Reproducible Research and Analyses
Version: 0.5.8
Version: 0.6.0
Authors@R:
person(given = "Jasen",
family = "Finch",
role = c("aut", "cre"),
email = "jsf9@aber.ac.uk")
Description: Project templates for reproducible research and analyses.
URL: https://github.com/jasenfinch/projecttemplates
URL: https://jasenfinch.github.io/projecttemplates/
BugReports: https://github.com/jasenfinch/projecttemplates/issues
License: GPL-3
Encoding: UTF-8
RoxygenNote: 7.1.2
Imports: glue,
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Imports: callr,
gert,
gh,
glue,
lubridate,
magrittr,
pacman,
renv,
rstudioapi,
stringr,
styler,
callr,
gh,
gert
yaml
Suggests:
testthat,
covr,
devtools,
wordcountaddin
Remotes: benmarwick/wordcountaddin
3 changes: 3 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Generated by roxygen2: do not edit by hand

export(Rprofile)
export(createGit)
export(createGithub)
export(docker)
Expand All @@ -11,6 +12,7 @@ export(projectTypes)
export(readme)
export(renvInitialise)
export(targets)
export(targetsConfig)
export(targetsPipeline)
export(targetsRun)
export(targetsScript)
Expand Down Expand Up @@ -43,3 +45,4 @@ importFrom(styler,style_file)
importFrom(utils,capture.output)
importFrom(utils,installed.packages)
importFrom(utils,packageVersion)
importFrom(yaml,write_yaml)
24 changes: 24 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# projecttemplates 0.6.0

* The template `run.R` script now outputs to `misc/run.R`. The template `README.md` has now been updated to reflect this.

* The template `misc/run.R` script now outputs a message to the console upon completion.

* The [`tarchetypes`](https://docs.ropensci.org/tarchetypes/) package is now referenced directly in template targets scripts.

* The template docker infrastructure now outputs to the directory `misc/docker` and now includes an image build script (`/misc/docker/build_image.sh`) and a container run script (`/misc/docker/run_container.sh`).

* [`jfmisc::writingChecks()`](https://jasenfinch.github.io/jfmisc/reference/writingChecks.html) now replaces the `manuscriptChecks()` function in the `manuscript` template.

* The `renv::restore()` command has now been moved to the template `.Rprofile`.

* The [`targets`](https://docs.ropensci.org/targets/) package and the magrittr `%>%` are now loaded via the template `.Rprofile`.

* The `bioconductor` argument replaces the `bioc` argument in `renvInitialise()` to stipulate the Bioconductor version to use.

* Added the `targetsConfig()` function to add a `_targets.yaml` to a project directory. This file is added automatically by the `template()` function.

* Fixed incorrect outputs in the figures, tables and supplementary output Rmarkdown files in the `manuscript` template.

* [`knitr`](https://yihui.org/knitr/) is now referenced directly in function calls in output template Rmarkdown files.

# projecttemplates 0.5.8

* The `renv` directory is now included in the generated `.dockerignore` file if argument `renv = TRUE`.
Expand Down
29 changes: 29 additions & 0 deletions R/Rprofile.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#' Add project .Rprofile
#' @description Add a template .Rprofile file to a project directory.
#' @param project_directory the project directory file path
#' @param renv add infrastructure for renv package environment management
#' @examples
#' \dontrun{
#' projectSkeleton(paste0(tempdir(),'/test_project'))
#' Rprofile(paste0(tempdir(),'/test_project'))
#' }
#' @export

Rprofile <- function(project_directory,
renv = TRUE){

if (isTRUE(renv)){
renv_restore <- 'renv::restore()'
} else {
renv_restore <- ''
}

script <- glue('
{scriptHeader()}
{renv_restore}
library(targets)
library(jfmisc,include.only = "%>%")
')

write(script,file = paste0(project_directory,'/.Rprofile'))
}

0 comments on commit e89c442

Please sign in to comment.