export message

Author: debruine

.Rbuildignore

@@ -1,3 +1,7 @@
 ^svutils\.Rproj$
 ^\.Rproj\.user$
 ^LICENSE\.md$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/pkgdown.yaml

@@ -0,0 +1,49 @@
+# 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:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+permissions: read-all
+
+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 }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - 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.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -4,3 +4,4 @@
 .httr-oauth
 .DS_Store
 .quarto
+docs

DESCRIPTION

@@ -28,5 +28,5 @@ Imports:
     curl,
     progress,
     urltools
-URL: https://github.com/scienceverse/svutils
+URL: https://github.com/scienceverse/svutils, http://www.scienceverse.org/svutils/
 BugReports: https://github.com/scienceverse/svutils/issues

NAMESPACE

@@ -1,6 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 export("%||%")
+export(message)
 export(online)
 export(pb)
 export(rep_if)

R/message.R

@@ -5,8 +5,7 @@
 #' @param appendLF append new line? (see \code{\link[base]{message}})
 #'
 #' @return TRUE
-#' @keywords internal
-#'
+#' @export
 message <- function(..., domain = NULL, appendLF = TRUE) {
   if (verbose()) {
     if (interactive()) {

_pkgdown.yml

@@ -0,0 +1,4 @@
+url: http://www.scienceverse.org/svutils/
+template:
+  bootstrap: 5
+

man/message.Rd

@@ -1,5 +1,22 @@
 test_that("message", {
-  expect_true(is.function(svutils:::message))
+  expect_true(is.function(svutils::message))
 
   expect_error(message(bad_arg))
 })
+
+test_that("message", {
+  verbose(TRUE)
+
+  msg <- capture_messages(message("hi"))
+
+  if (interactive()) {
+    expect_equal(msg, "\033[32mhi\033[39m\n")
+  } else {
+    expect_equal(msg, "hi\n")
+  }
+
+  verbose(FALSE)
+
+  msg <- capture_messages(message("hi"))
+  expect_equal(msg, character(0))
+})