CRAN prerequisites

Author: Exceret

.github/workflows/rhub.yaml

@@ -0,0 +1,99 @@
+# R-hub's generic GitHub Actions workflow file. It's canonical location is at
+# https://github.com/r-hub/actions/blob/v1/workflows/rhub.yaml
+# You can update this file to a newer version using the rhub2 package:
+#
+# rhub::rhub_setup()
+#
+# It is unlikely that you need to modify this file manually.
+
+name: R-hub
+run-name: >-
+  ${{ github.event.inputs.id || format('Manual run by @{0}', github.triggering_actor) }}:
+  ${{ github.event.inputs.name || github.event.inputs.config }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      config:
+        description: >-
+          Comma-separated list of R-hub platforms to use.
+          Full list: https://r-hub.github.io/containers/
+        type: string
+        default: 'linux,windows,macos'
+      name:
+        description: 'Run name. You can leave this empty.'
+        type: string
+      id:
+        description: 'Unique ID. You can leave this empty.'
+        type: string
+
+jobs:
+
+  setup:
+    runs-on: ubuntu-latest
+    outputs:
+      containers: ${{ steps.rhub-setup.outputs.containers }}
+      platforms: ${{ steps.rhub-setup.outputs.platforms }}
+
+    steps:
+    # NO NEED TO CHECKOUT HERE
+    - uses: r-hub/actions/setup@v1
+      with:
+        config: ${{ github.event.inputs.config }}
+      id: rhub-setup
+
+  linux-containers:
+    needs: setup
+    if: ${{ needs.setup.outputs.containers != '[]' }}
+    runs-on: ubuntu-latest
+    name: ${{ matrix.config.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config: ${{ fromJson(needs.setup.outputs.containers) }}
+    container:
+      image: ${{ matrix.config.container }}
+
+    steps:
+      - uses: r-hub/actions/checkout@v1
+      - uses: r-hub/actions/platform-info@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+      - uses: r-hub/actions/setup-deps@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+      - uses: r-hub/actions/run-check@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+
+  other-platforms:
+    needs: setup
+    if: ${{ needs.setup.outputs.platforms != '[]' }}
+    runs-on: ${{ matrix.config.os }}
+    name: ${{ matrix.config.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config: ${{ fromJson(needs.setup.outputs.platforms) }}
+
+    steps:
+      - uses: r-hub/actions/checkout@v1
+      - uses: r-hub/actions/setup-r@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}
+      - uses: r-hub/actions/platform-info@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+      - uses: r-hub/actions/setup-deps@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}
+      - uses: r-hub/actions/run-check@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}

DESCRIPTION

@@ -1,9 +1,12 @@
 Package: rpkgkit
-Title: A Set of Tools to Help You Create and Maintain an R Package
+Title: Create and Maintain 'R' Packages
 Version: 0.0.7
 Authors@R: 
     person("Yuxi", "Yang", , "15364051195@163.com", role = c("aut", "cre"))
-Description: A set of tools to help you create and maintain an R package.
+Description: Create and maintain R packages with utilities for NEWS.md
+    management, standalone file creation, and code formatting. Supports popular
+    development workflows and integrates with 'usethis' and 'RStudio'. Includes
+    helper functions for renaming functions and detecting common coding errors.
 License: MIT + file LICENSE
 URL: https://github.com/WangLabCSU/rpkgkit
 BugReports: https://github.com/WangLabCSU/rpkgkit/issues
@@ -32,5 +35,4 @@ Imports:
     cli,
     rlang,
     rstudioapi
-Remotes:
-    github::wurli/pedant
+

R/10_air_format.R

@@ -14,6 +14,10 @@
 #'
 #' @return The exit status of the `air format` command (invisibly).
 #'
+#' @examples
+#' \dontrun{
+#' air_format(system.file("", package = "rpkgkit"))
+#' }
 #' @export
 air_format <- function(path = NULL, ...) {
   check_air_installed()

R/11_flir_fix.R

@@ -16,6 +16,11 @@
 #'
 #' @return Invisibly returns the result from the called flir function.
 #'
+#' @examplesIf rlang::is_installed("flir")
+#' tmp <- tempfile(fileext = ".R")
+#' writeLines("a<-1+1", tmp)
+#' flir_fix(tmp)
+#' cat(readLines(tmp, warn = FALSE), sep = "\n")
 #' @export
 flir_fix <- function(path = NULL, ...) {
   rlang::check_installed("flir")

R/12_render_rmd.R

@@ -7,6 +7,13 @@
 #'
 #' @return The output file path from rmarkdown::render.
 #'
+#' @examples
+#' \dontrun{
+#' rlang::is_installed("rmarkdown")
+#' tmp <- tempfile(fileext = ".Rmd")
+#' writeLines(c("---", "title: Test", "---", "", "Hello, world!"), tmp)
+#' render_rmd(tmp)
+#' }
 #' @export
 render_rmd <- function(path = NULL, output_format = "md_document", ...) {
   rlang::check_installed("rmarkdown")

R/13_make_func_call_explicit.R

@@ -42,7 +42,15 @@ make_func_call_explicit <- function(
   ...
 ) {
   rlang::check_dots_empty0()
-  rlang::check_installed("pedant")
+  if (!rlang::is_installed("pedant")) {
+    choice <- utils::askYesNo(cli::cli_fmt(cli::cli_alert_info(
+      "{.pkg pedant} is not installed. Would you like to install it?"
+    )))
+    if (!isTRUE(choice)) {
+      stop("Installation of pedant package is required")
+    }
+    pak::pkg_install("wurli/pedant")
+  }
   path <- if (is.null(path) && rlang::is_installed("rstudioapi")) {
     rstudioapi::getActiveDocumentContext()$path
   } else {

R/20_inquire_standalone.R

@@ -15,6 +15,10 @@
 #'
 #' @details This function queries the GitHub API to list files in the R/ directory, filters for files starting with "standalone-", parses each file's YAML metadata (delimited by "# ---") and roxygen tags to extract descriptions, and generates usage code for importing each standalone file.
 #'
+#' @examples
+#' \dontrun{
+#' inquire_standalone("r-lib", "rlang")
+#' }
 #' @export
 inquire_standalone <- function(owner, repo, ...) {
   rlang::check_dots_empty0()

R/21_create_standalone.R

@@ -24,6 +24,10 @@
 #'
 #' @return Invisibly returns the path to the created file.
 #'
+#' @examples
+#' \dontrun{
+#' create_standalone("my_utils", path = tempdir())
+#' }
 #' @export
 create_standalone <- function(
   standalone_name = NULL,

R/22_update_time_in_standalone.R

@@ -10,6 +10,10 @@
 #'
 #' @return Invisibly returns a character vector of updated file paths.
 #'
+#' @examples
+#' \dontrun{
+#' update_time_in_standalone(tempdir())
+#' }
 #' @export
 update_time_in_standalone <- function(path = NULL) {
   if (is.null(path) && rlang::is_installed("rstudioapi")) {

R/23_add_changelog_in_standalone.R

@@ -15,6 +15,10 @@
 #'
 #' @return Invisibly returns the path to the updated file.
 #'
+#' @examples
+#' \dontrun{
+#' add_changelog_in_standalone(tempdir(), "Added new feature")
+#' }
 #' @export
 add_changelog_in_standalone <- function(
   path = NULL,