Expose function 'sideCode'

baddstats · baddstats · commit 62f0a5501b91 · 2025-06-28T11:02:25.000+08:00
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: spatstat.utils
-Version: 3.1-4
-Date: 2025-05-15
+Version: 3.1-4.001
+Date: 2025-06-28
 Title: Utility Functions for 'spatstat'
 Authors@R: c(person("Adrian", "Baddeley", 
                     role = c("aut", "cre"),
diff --git a/NAMESPACE b/NAMESPACE
@@ -173,6 +173,7 @@ export("rhs.of.formula<-")
 export("samefunction")
 export("sensiblevarname")
 export("short.deparse")
+export("sideCode")
 export("simplenumber")
 export("simplify.xypolygon")
 export("singlestring")
diff --git a/NEWS b/NEWS
@@ -1,4 +1,10 @@
 
+        CHANGES IN spatstat.utils VERSION 3.1-4.001
+
+OVERVIEW
+
+    o Internal improvements.
+
         CHANGES IN spatstat.utils VERSION 3.1-4
 
 OVERVIEW
diff --git a/R/utilarg.R b/R/utilarg.R
@@ -3,7 +3,7 @@
 #'
 #'   Utilities for checking/handling arguments
 #'
-#'  $Revision: 1.16 $  $Date: 2025/05/08 04:21:49 $
+#'  $Revision: 1.18 $  $Date: 2025/06/28 02:29:54 $
 #'
 
 "%orifnull%" <- function(a, b) {
@@ -471,3 +471,17 @@ getdataobjects <- function(nama, envir, datalist=NULL, fatal=FALSE) {
   return(y)
 }
 
+sideCode <- function(side, what=c("number", "word")) {
+  words <- c("bottom", "left", "top", "right")
+  if(is.numeric(side)) {
+    stopifnot(side %in% 1:4)
+    n <- side
+  } else if(is.character(side)) {
+    side <- match.arg(side, words)
+    n <- match(side, words)
+  } else stop("Unrecognised format for 'side'")
+  what <- match.arg(what)
+  result <- switch(what, number=n, word=words[n])
+  return(result)
+}
+
diff --git a/inst/doc/packagesizes.txt b/inst/doc/packagesizes.txt
@@ -29,3 +29,4 @@ date version nhelpfiles nobjects ndatasets Rlines srclines
 "2024-11-02" "3.1-1" 41 189 0 3614 2429
 "2025-03-15" "3.1-3" 42 192 0 3650 2429
 "2025-05-15" "3.1-4" 42 193 0 3689 2462
+"2025-06-28" "3.1-4.001" 42 194 0 3703 2462
diff --git a/inst/info/packagesizes.txt b/inst/info/packagesizes.txt
@@ -29,3 +29,4 @@ date version nhelpfiles nobjects ndatasets Rlines srclines
 "2024-11-02" "3.1-1" 41 189 0 3614 2429
 "2025-03-15" "3.1-3" 42 192 0 3650 2429
 "2025-05-15" "3.1-4" 42 193 0 3689 2462
+"2025-06-28" "3.1-4.001" 42 194 0 3703 2462
diff --git a/man/macros/defns.Rd b/man/macros/defns.Rd
@@ -5,20 +5,21 @@
 \newcommand{\ege}{Ege Rubak \email{rubak@math.aau.dk}}
 \newcommand{\spatstatAuthors}{\adrian, \rolf and \ege}
 \newcommand{\spatstatAuthorsComma}{\adrian, \rolf, \ege}
-%% Contributors with emails
-\newcommand{\pavel}{Pavel Grabarnik \email{pavel.grabar@issp.serpukhov.su}}
-\newcommand{\dominic}{Dominic Schuhmacher \email{dominic.schuhmacher@mathematik.uni-goettingen.de}, URL \code{http://dominic.schuhmacher.name/}}
-\newcommand{\wei}{Ang Qi Wei \email{aqw07398@hotmail.com}}
-\newcommand{\colette}{Marie-Colette van Lieshout \email{Marie-Colette.van.Lieshout@cwi.nl}}
-\newcommand{\rasmus}{Rasmus Plenge Waagepetersen \email{rw@math.auc.dk}}
+%% Contributors with emails (alphabetical order)
 \newcommand{\abdollah}{Abdollah Jalilian \email{jalilian@razi.ac.ir}}
+\newcommand{\colette}{Marie-Colette van Lieshout \email{Marie-Colette.van.Lieshout@cwi.nl}}
+\newcommand{\dominic}{Dominic Schuhmacher \email{dominic.schuhmacher@mathematik.uni-goettingen.de}, URL \code{http://dominic.schuhmacher.name/}}
+\newcommand{\martinH}{Martin Hazelton \email{Martin.Hazelton@otago.ac.nz}}
+\newcommand{\mehdi}{Mehdi Moradi \email{m2.moradi@yahoo.com}}
 \newcommand{\ottmar}{Ottmar Cronie \email{ottmar@chalmers.se}}
+\newcommand{\pavel}{Pavel Grabarnik \email{pavel.grabar@issp.serpukhov.su}}
+\newcommand{\rasmus}{Rasmus Plenge Waagepetersen \email{rw@math.auc.dk}}
 \newcommand{\stephenEglen}{Stephen Eglen \email{S.J.Eglen@damtp.cam.ac.uk}}
-\newcommand{\mehdi}{Mehdi Moradi \email{m2.moradi@yahoo.com}}
-\newcommand{\yamei}{Ya-Mei Chang \email{yamei628@gmail.com}}
-\newcommand{\martinH}{Martin Hazelton \email{Martin.Hazelton@otago.ac.nz}}
+\newcommand{\suman}{Suman Rakshit \email{Suman.Rakshit@curtin.edu.au}}
 \newcommand{\tilman}{Tilman Davies \email{Tilman.Davies@otago.ac.nz}}
-% Names with accents
+\newcommand{\wei}{Ang Qi Wei \email{aqw07398@hotmail.com}}
+\newcommand{\yamei}{Ya-Mei Chang \email{yamei628@gmail.com}}
+% Names with accents (alphabetical order)
 \newcommand{\Bogsted}{\ifelse{latex}{\out{B\o gsted}}{Bogsted}}
 \newcommand{\Cramer}{\ifelse{latex}{\out{Cram\'er}}{Cramer}}
 \newcommand{\Francois}{\ifelse{latex}{\out{Fran\c{c}ois}}{Francois}}
@@ -46,5 +47,9 @@
 \newcommand{\baddchangclustersim}{Baddeley, A. and Chang, Y.-M. (2023) Robust algorithms for simulating cluster point processes. \emph{Journal of Statistical Computation and Simulation} \bold{93}, 1950--1975.}
 \newcommand{\smoothpcfpaper}{Baddeley, A., Davies, T.M. and Hazelton, M.L. (2025) An improved estimator of the pair correlation function of a spatial point process. \emph{Biometrika}, to appear.}
 \newcommand{\smoothpcfpapercite}{Baddeley, Davies and Hazelton (2025)}
+%% ROC paper
+\newcommand{\rocketAuthors}{\adrian, \ege and \suman}
+\newcommand{\rocpapercite}{Baddeley et al (2025)}
+\newcommand{\rocpaper}{Baddeley, A., Rubak, E., Rakshit, S. and Nair, G. (2025) ROC curves for spatial point patterns and presence-absence data. \url{https://doi.org/10.48550/arXiv.2506.03414}.}
 
 
diff --git a/man/spatstat.utils-internal.Rd b/man/spatstat.utils-internal.Rd
@@ -76,6 +76,7 @@
 \alias{samefunction}
 \alias{sensiblevarname}
 \alias{short.deparse}
+\alias{sideCode}
 \alias{singlestring}
 \alias{sortunique}
 \alias{startinrange}
@@ -186,6 +187,7 @@ ratiotweak(a, b, overzero, zerozero)
 samefunction(f, g)
 sensiblevarname(guess, fallback, maxlen)
 short.deparse(x, maxlen)
+sideCode(side, what)
 singlestring(s, coll)
 sortunique(x)
 startinrange(x0, dx, r)
