scripts/contribute.R

In jdblischak/workflowr: A Framework for Reproducible and Collaborative Data Science

#!/usr/bin/env Rscript

# Please run this script before you submit your Pull Request on GitHub.
#
# Usage:
#   In the R console: source("scripts/contribute.R")
#   In the terminal: Rscript scripts/contribute.R
#   In RStudio: Click on Source (Ctrl/Cmd-Shift-s)
#
# Thanks for contributing to workflowr!

# Print warnings as they occur
options(warn = 1)

# Check required packages ------------------------------------------------------

message("* Checking that required dependencies are installed")
pkgs <- c("devtools", "fs", "git2r", "roxygen2", "stringr",
          "testthat", "withr")
installed <- rownames(installed.packages())

for (p in pkgs) {
  if (!p %in% installed) {
    msg <- sprintf("%s is required. Install with install.packages(\"%s\")", p, p)
    stop(msg, call. = FALSE)
  }
}

# Check setup ------------------------------------------------------------------

message("* Checking setup")

if (!file.exists("workflowr.Rproj")) {
  stop("Please run this script from the root directory.",
       "\nUse setwd() or in RStudio Click Session -> Set Working Directory -> To Project Directory",
       call. = FALSE)
}

if (!git2r::in_repository()) {
  stop("Something went wrong with the Git repository", call. = FALSE)
}

r <- git2r::repository()
# b <- git2r::repository_head(r)$name

remote_avail <- git2r::remotes(r)
if (!"origin" %in% remote_avail) {
  warning("There is no remote named origin", call. = FALSE)
} else {
  origin <- git2r::remote_url(r, "origin")
  if (stringr::str_detect(origin, "workflowr/workflowr.git$")) {
    warning("The remote origin is set to the main workflowr repository.",
            "\nDid you fork the repository on GitHub and then clone your fork?",
            call. = FALSE)
  }
}

# Update documentation ---------------------------------------------------------

message("* Updating documentation")
o <- utils::capture.output(suppressMessages(
  devtools::document(roclets = c('rd', 'collate', 'namespace'))
))

# Notify to commit any changes to documentation files
status <- git2r::status(r)
changed <- c(unlist(status$unstaged), unlist(status$staged))
docs <- c("DESCRIPTION", fs::dir_ls("man/"), "NAMESPACE")
for (f in docs) {
  if (f %in% changed) {
    cat("To do: Please commit changes to", f, "\n")
  }
}

# Check package ----------------------------------------------------------------

message("* Checking package (this might take a few minutes)")
devtools::check(document = FALSE, args = "--no-tests", quiet = TRUE,
                error_on = "error")

# Finish -----------------------------------------------------------------------

message("* Congrats! Please commit your changes, push them to GitHub, and open a Pull Request")