New function

Author: baddstats

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: spatstat.utils
-Version: 3.2-3
-Date: 2026-05-10
+Version: 3.2-3.002
+Date: 2026-07-15
 Title: Utility Functions for 'spatstat'
 Authors@R: c(person("Adrian", "Baddeley", 
                     role = c("aut", "cre"),

NAMESPACE

@@ -33,6 +33,7 @@ export("can.be.formula")
 export("capitalise")
 export("cat.factor")
 export("check.1.integer")
+export("check.1.logical")
 export("check.1.real")
 export("check.1.string")
 export("check.anyvector")
@@ -63,6 +64,7 @@ export("dropifsingle")
 export("dround")
 export("ensure2vector")
 export("ensure3Darray")
+export("ensure.nlist")
 export("equispaced")          
 export("eratosthenes")
 export("evenly.spaced")

NEWS

@@ -1,4 +1,17 @@
 
+        CHANGES IN spatstat.utils VERSION 3.2-3.002
+
+OVERVIEW
+
+    o Check logical arguments.
+
+    o Internal improvements.
+
+NEW FUNCTIONS
+
+    o check.1.logical
+    Check whether an argument is a single logical value.
+
         CHANGES IN spatstat.utils VERSION 3.2-3
 
 OVERVIEW

R/utilarg.R

@@ -3,7 +3,7 @@
 #'
 #'   Utilities for checking/handling arguments
 #'
-#'  $Revision: 1.18 $  $Date: 2025/06/28 02:29:54 $
+#'  $Revision: 1.19 $  $Date: 2026/07/15 03:11:51 $
 #'
 
 "%orifnull%" <- function(a, b) {
@@ -281,6 +281,18 @@ check.1.string <- function(x, context="", fatal=TRUE, warn=TRUE) {
   return(FALSE)
 }
 
+check.1.logical <- function(x, context="", fatal=TRUE, warn=TRUE) {
+  if(is.logical(x) && length(x) == 1)
+    return(TRUE)
+  if(fatal || warn) {
+    xname <- short.deparse(substitute(x))
+    whinge <- paste(sQuote(xname), "should be a single logical value")
+    if(nzchar(context)) whinge <- paste(context, whinge)
+    if(fatal) stop(whinge, call.=FALSE) else warning(whinge, call.=FALSE)
+  }
+  return(FALSE)
+}
+
 complaining <- function(whinge, fatal=FALSE, value=NULL) {
   if(fatal) stop(whinge, call.=FALSE)
   warning(whinge, call.=FALSE)
@@ -364,6 +376,46 @@ there.can.be.only.one <- function(..., .NeedOne=TRUE, .Fatal=TRUE) {
   return(TRUE)
 }
 
+## Ensure that x is a list of length n,
+## which can be passed to 'mapply'
+## Input 'x' can be a single object of a recognised class,
+## which will be replicated to the required length.
+
+ensure.nlist <- function(x, n, singletypes=character(0), 
+                         xtitle=NULL, things="point patterns") {
+  if(length(singletypes) && inherits(x, singletypes)) {
+    ## single object of recognised class: replicate it
+    x <- rep(list(x), n)
+    return(x)
+  } 
+  if(!is.list(x)) {
+    ## error 
+    if(is.null(xtitle)) xtitle <- short.deparse(substitute(x))
+    whinge <- paste(xtitle, "should be a list")
+    if(length(singletypes)) {
+      otypes <- setdiff(singletypes, "NULL")
+      if(length(otypes))
+        whinge <- paste(whinge,
+                        "or an object of class",
+                        commasep(dQuote(otypes), "or"))
+      if("NULL" %in% singletypes)
+        whinge <- paste(whinge, "or NULL")
+    }
+    stop(whinge, call.=FALSE)
+  }
+  nx <- length(x)
+  if(nx != n) {
+    if(is.null(xtitle)) xtitle <- short.deparse(substitute(x))
+    whinge <- paste("The length of",
+                    sQuote(xtitle), 
+                    "should equal the number of",
+                    things,
+                    paren(paste(nx, "!=", n)))
+    stop(whinge, call.=FALSE)
+  }
+  return(x)
+}
+  
 ## replace recognised keywords by other keywords
 mapstrings <- function(x, map=NULL) {
   if(is.null(map)) return(x)

inst/doc/packagesizes.txt

@@ -34,3 +34,4 @@ date version nhelpfiles nobjects ndatasets Rlines srclines
 "2026-01-08" "3.2-1" 43 196 0 3754 2535
 "2026-03-10" "3.2-2" 44 197 0 3778 2535
 "2026-05-10" "3.2-3" 44 197 0 3817 2683
+"2026-07-15" "3.2-3.002" 44 199 0 3869 2683

inst/info/packagesizes.txt

@@ -34,3 +34,4 @@ date version nhelpfiles nobjects ndatasets Rlines srclines
 "2026-01-08" "3.2-1" 43 196 0 3754 2535
 "2026-03-10" "3.2-2" 44 197 0 3778 2535
 "2026-05-10" "3.2-3" 44 197 0 3817 2683
+"2026-07-15" "3.2-3.002" 44 199 0 3869 2683

man/check.1.integer.Rd

@@ -2,6 +2,7 @@
 \alias{check.1.integer}
 \alias{check.1.real}
 \alias{check.1.string}
+\alias{check.1.logical}
 \title{
   Check Argument Type and Length
 }
@@ -13,6 +14,7 @@
 check.1.real(x, context = "", fatal = TRUE, warn=TRUE)
 check.1.integer(x, context = "", fatal = TRUE, warn=TRUE)
 check.1.string(x, context = "", fatal = TRUE, warn=TRUE)
+check.1.logical(x, context = "", fatal = TRUE, warn=TRUE)
 }
 \arguments{
   \item{x}{
@@ -33,8 +35,8 @@ check.1.string(x, context = "", fatal = TRUE, warn=TRUE)
 }
 \details{
   These functions check whether the argument \code{x} is a single
-  atomic value of type \code{numeric}, \code{integer} or
-  \code{character}.
+  atomic value of type \code{numeric}, \code{integer},
+  \code{character} or \code{logical}.
 
   If \code{x} does have the required length and type, the result
   of the function is the logical value \code{TRUE}.
@@ -58,6 +60,7 @@ check.1.string(x, context = "", fatal = TRUE, warn=TRUE)
   check.1.integer(pi, fatal=FALSE, context="In your dreams,")
   check.1.string(x, fatal=FALSE)
   check.1.integer(x, fatal=FALSE, warn=FALSE)
+  check.1.logical(pi, fatal=FALSE, warn=FALSE)
 }
 \keyword{classes}
 \keyword{error}

man/spatstat.utils-internal.Rd

@@ -24,6 +24,7 @@
 \alias{dround}
 \alias{ensure2vector}
 \alias{ensure3Darray}
+\alias{ensure.nlist}
 \alias{eratosthenes}
 \alias{exceedsMaxArraySize}
 \alias{exhibitStringList}
@@ -136,6 +137,7 @@ dropifsingle(x)
 dround(x)
 ensure2vector(x)
 ensure3Darray(x)
+ensure.nlist(x, n, singletypes, xtitle, things)
 eratosthenes(nmax, startset)
 exhibitStringList(prefix, strings)
 exceedsMaxArraySize(\dots)