rename to dot prefix

Author: jangorecki

NAMESPACE

@@ -215,7 +215,7 @@ S3method(format_list_item, data.frame)
 export(fdroplevels, setdroplevels)
 S3method(droplevels, data.table)
 export(frev)
-export(selfref.ok)
+export(.selfref.ok)
 
 # sort_by added in R 4.4.0, #6662, https://stat.ethz.ch/pipermail/r-announce/2024/000701.html
 if (getRversion() >= "4.4.0") S3method(sort_by, data.table)  

R/helpers.R

@@ -12,8 +12,8 @@ fctr = function(x, levels=unique(x), ..., sort=FALSE, rev=FALSE) {
 }
 
 # add a function for validating data.tables that might need setDT #7329
-selfref.ok = function(x) {
+.selfref.ok = function(x) {
   if (!is.data.table(x))
-    stopf("selfref.ok expects data.table class object.")
+    stopf(".selfref.ok expects data.table class object.")
   selfrefok(x, verbose=FALSE) > 0L
 }

inst/tests/tests.Rraw

@@ -21657,18 +21657,18 @@ local({
 })
 
 # Add a function for validating data.tables that might need setDT #7329
-test(2340.00, selfref.ok(data.frame(V1=1L)), error="selfref.ok expects data.table class object")
+test(2340.00, .selfref.ok(data.frame(V1=1L)), error=".selfref.ok expects data.table class object")
 d1 = structure(list(V1=1L), class=c("data.table","data.frame"))
-test(2340.01, selfref.ok(d1), FALSE)
+test(2340.01, .selfref.ok(d1), FALSE)
 setDT(d1)
-test(2340.02, selfref.ok(d1), TRUE)
+test(2340.02, .selfref.ok(d1), TRUE)
 saveRDS(d1, f<-tempfile())
 d2 = readRDS(f)
-test(2340.03, selfref.ok(d2), FALSE)
+test(2340.03, .selfref.ok(d2), FALSE)
 invisible(file.remove(f))
 setDT(d2)
-test(2340.04, selfref.ok(d2), TRUE)
+test(2340.04, .selfref.ok(d2), TRUE)
 d3 = unserialize(serialize(d2, NULL))
-test(2340.05, selfref.ok(d3), FALSE)
+test(2340.05, .selfref.ok(d3), FALSE)
 setDT(d3)
-test(2340.06, selfref.ok(d3), TRUE)
+test(2340.06, .selfref.ok(d3), TRUE)

man/selfref.ok.Rd man/.selfref.ok.Rdman/selfref.ok.Rd renamed to man/.selfref.ok.Rd

@@ -1,11 +1,11 @@
-\name{selfref.ok}
-\alias{selfref.ok}
+\name{.selfref.ok}
+\alias{.selfref.ok}
 \title{Tests self reference of a data.table}
 \description{
   In rare situations, as presented in examples below, a data.table object may lose its internal attribute that holds a self-reference. This function tests just that.
 }
 \usage{
-  selfref.ok(x)
+  .selfref.ok(x)
 }
 \arguments{
   \item{x}{ A data.table. }
@@ -15,20 +15,20 @@
 }
 \examples{
 d1 = structure(list(V1=1L), class=c("data.table","data.frame"))
-selfref.ok(d1)
+.selfref.ok(d1)
 setDT(d1)
-selfref.ok(d1)
+.selfref.ok(d1)
 
 saveRDS(d1, f<-tempfile())
 d2 = readRDS(f)
-selfref.ok(d2)
+.selfref.ok(d2)
 invisible(file.remove(f))
 setDT(d2)
-selfref.ok(d2)
+.selfref.ok(d2)
 
 d3 = unserialize(serialize(d2, NULL))
-selfref.ok(d3)
+.selfref.ok(d3)
 setDT(d3)
-selfref.ok(d3)
+.selfref.ok(d3)
 }
 \keyword{ data }