Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Un-export S3 methods #76

Open
MichaelChirico opened this issue Oct 14, 2024 · 3 comments
Open

Un-export S3 methods #76

MichaelChirico opened this issue Oct 14, 2024 · 3 comments

Comments

@MichaelChirico
Copy link
Collaborator

bit64/R/bit64-package.R

Lines 903 to 947 in b6ab4c0

#' @export -.integer64 : :.default :.integer64 !.integer64 !=.integer64
#' @export [.integer64 [[.integer64 [[<-.integer64 [<-.integer64 *.integer64
#' @export /.integer64 &.integer64 %/%.integer64 %%.integer64 %in% %in%.default
#' @export %in%.integer64 ^.integer64 +.integer64 <.integer64 <=.integer64
#' @export ==.integer64 >.integer64 >=.integer64 |.integer64 abs.integer64
#' @export all.equal.integer64 all.integer64 any.integer64 as.bitstring.integer64
#' @export as.character.integer64 as.data.frame.integer64 as.double.integer64
#' @export as.integer.integer64 as.integer64.bitstring as.integer64.character
#' @export as.integer64.double as.integer64.factor as.integer64.integer
#' @export as.integer64.integer64 as.integer64.logical as.integer64.NULL
#' @export as.list.integer64 as.logical.integer64 c.integer64 cbind.integer64
#' @export ceiling.integer64 cummax.integer64 cummin.integer64 cumprod.integer64
#' @export cumsum.integer64 diff.integer64 duplicated.integer64 floor.integer64
#' @export format.integer64 hashdup.cache_integer64 hashfin.cache_integer64
#' @export hashfun.integer64 hashmap.integer64 hashmaptab.integer64
#' @export hashmapuni.integer64 hashmapupo.integer64 hashpos.cache_integer64
#' @export hashrev.cache_integer64 hashrin.cache_integer64
#' @export hashtab.cache_integer64 hashuni.cache_integer64
#' @export hashupo.cache_integer64 is.double is.double.default
#' @export is.double.integer64 is.finite.integer64 is.infinite.integer64
#' @export is.na.integer64 is.nan.integer64 is.sorted.integer64
#' @export is.vector.integer64 keypos.integer64 length<-.integer64 log.integer64
#' @export log10.integer64 log2.integer64 match match.default match.integer64
#' @export max.integer64 mean.integer64 median.integer64 mergeorder.integer64
#' @export mergesort.integer64 mergesortorder.integer64 min.integer64
#' @export na.count.integer64 nties.integer64 nunique.integer64 nvalid.integer64
#' @export order order.default order.integer64 orderdup.integer64
#' @export orderfin.integer64 orderkey.integer64 ordernut.integer64
#' @export orderpos.integer64 orderqtl.integer64 orderrnk.integer64
#' @export ordertab.integer64 ordertie.integer64 orderuni.integer64
#' @export orderupo.integer64 prank.integer64 print.bitstring print.cache
#' @export print.integer64 prod.integer64 qtile.integer64 quantile.integer64
#' @export quickorder.integer64 quicksort.integer64 quicksortorder.integer64
#' @export radixorder.integer64 radixsort.integer64 radixsortorder.integer64
#' @export ramorder.integer64 ramsort.integer64 ramsortorder.integer64
#' @export range.integer64 rank rank.default rank.integer64 rbind.integer64
#' @export rep.integer64 round.integer64 scale.integer64 seq.integer64
#' @export shellorder.integer64 shellsort.integer64 shellsortorder.integer64
#' @export sign.integer64 signif.integer64 sort.integer64 sortfin.integer64
#' @export sortnut.integer64 sortorderdup.integer64 sortorderkey.integer64
#' @export sortorderpos.integer64 sortorderrnk.integer64 sortordertab.integer64
#' @export sortordertie.integer64 sortorderuni.integer64 sortorderupo.integer64
#' @export sortqtl.integer64 sorttab.integer64 sortuni.integer64 sqrt.integer64
#' @export str.integer64 sum.integer64 summary.integer64 tiepos.integer64
#' @export trunc.integer64 unipos.integer64 unique.integer64 xor.integer64

My understanding is these would have been written/exported before the concept of "namespace" was really a thing in R, and before the Imports/Depends separation existed.

These objects were exported as of the initial CRAN release 13 years ago:

cran/bit64@f7e0fac

Probably, they can be un-exported without incident; a glance at a few shows no reference to calling them directly on GitHub.

That said, this will constitute a breaking change in some cases, and should thus be taken up gently, starting with an announcement in the next release and gradual deprecation thereafter.
@MichaelChirico
Copy link
Collaborator Author

MichaelChirico commented Oct 16, 2024 •
edited
Loading

Not seen on GitHub:

  • !.integer64
  • &.integer64
  • *.integer64
  • +.integer64
  • -.integer64
  • /.integer64
  • :.integer64
  • <.integer64
  • >.integer64 (well, this is called once in ::: form, so unexporting won't matter: https://github.com/zeugner/MD3/blob/253ef4df91470a2d1d7813c1d721155eb810fb40/R/md3timo64.R#L939)
  • [.integer64
  • ^.integer64
  • |.integer64
  • %%.integer64
  • %/%.integer64
  • %in%.integer64
  • ==.integer64
  • !=.integer64
  • <=.integer64
  • >=.integer64
  • [[.integer64
  • [[<-.integer64
  • diff.integer64 (used as :::: https://github.com/zeugner/MD3/blob/253ef4df91470a2d1d7813c1d721155eb810fb40/R/md3timo64.R#L105)
  • log2.integer64
  • mean.integer64
  • prod.integer64
  • sign.integer64
  • sort.integer64
  • sqrt.integer64
  • cbind.integer64
  • floor.integer64
  • log10.integer64
  • match.integer64
  • nties.integer64
  • order.integer64
  • prank.integer64
  • qtile.integer64
  • range.integer64 (used as :::: https://github.com/zeugner/MD3/blob/253ef4df91470a2d1d7813c1d721155eb810fb40/R/md3timo64.R#L1140)
  • rbind.integer64
  • round.integer64
  • scale.integer64
  • table.integer64
  • trunc.integer64
  • cummax.integer64
  • cummin.integer64
  • cumsum.integer64
  • is.nan.integer64
  • keypos.integer64
  • median.integer64
  • nvalid.integer64
  • signif.integer64
  • tiepos.integer64
  • unipos.integer64
  • as.list.integer64
  • ceiling.integer64
  • cumprod.integer64
  • hashfun.integer64
  • hashmap.integer64
  • nunique.integer64
  • ramsort.integer64
  • sortfin.integer64
  • sortnut.integer64
  • sortql.integer64
  • sorttab.integer64
  • sortuni.integer64
  • summary.integer64
  • length<-.integer64
  • na.count.integer64
  • orderdup.integer64
  • orderfin.integer64
  • orderkey.integer64
  • ordernut.integer64
  • orderpos.integer64
  • orderqtl.integer64
  • orderrnk.integer64
  • ordertab.integer64
  • ordertie.integer64
  • orderuni.integer64
  • orderupo.integer64
  • quantile.integer64
  • ramorder.integer64
  • all.equal.integer64
  • is.double.integer64
  • is.finite.integer64
  • is.sorted.integer64
  • is.vector.integer64
  • mergesort.integer64
  • quicksort.integer64
  • radixsort.integer64
  • shellsort.integer64
  • as.logical.integer64
  • duplicated.integer64
  • hashmaptab.integer64
  • hashmapuni.integer64
  • hashmapupo.integer64
  • mergeorder.integer64
  • quickorder.integer64
  • radixorder.integer64
  • shellorder.integer64
  • is.infinite.integer64
  • as.bitstring.integer64
  • as.integer64.integer64
  • ramsortorder.integer64
  • sortorderdup.integer64
  • sortorderkey.integer64
  • sortorderpos.integer64
  • sortorderrnk.integer64
  • sortordertab.integer64
  • sortordertie.integer64
  • sortorderuni.integer64
  • sortorderupo.integer64
  • mergesortorder.integer64
  • quicksortorder.integer64
  • radixsortorder.integer64
  • shellsortorder.integer64
  • hashdup.cache_integer64
  • hashfin.cache_integer64
  • hashpos.cache_integer64
  • hashrev.cache_integer64
  • hashrin.cache_integer64
  • hashtab.cache_integer64
  • hashuni.cache_integer64
  • hashupo.cache_integer64
  • as.integer64.factor
  • as.integer64.NULL
  • print.bitstring
  • :.default
  • %in%.default
  • is.double.default
  • match.default
  • order.default
  • rank.default

Definitely used elsewhere:

  • abs.integer64
  • as.character.integer64
  • as.data.frame.integer64
  • as.double.integer64
  • as.integer.integer64
  • as.integer64.bitstring
  • as.integer64.character
  • as.integer64.double
  • as.integer64.integer
  • as.integer64.logical
  • c.integer64
  • format.integer64
  • identical.integer64
  • is.na.integer64
  • max.integer64
  • min.integer64
  • print.integer64
  • rank.integer64
  • seq.integer64
  • str.integer64
  • sum.integer64
  • unique.integer64

Searches:

https://github.com/search?q=lang%3AR+%2F%5B-%2B*%5C%2F%5E%21%7C%26%3C%3E%5C%5B%5D%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ainteger64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%25%28in%7C%5C%2F%29%3F%25%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%28%21%3D%7C%3C%3D%7C%3D%3D%7C%3E%3D%7C%5C%5B%5C%5B%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2Fc%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%28%5C%5B%3C-%7Cany%7Call%7Clog%7Crep%7Cxor%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%28abs%7Clim%7Cmax%7Cmin%7Cseq%7Cstr%7Csum%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28%5C%5B%5C%5B%3C-%7Cdiff%7Clog2%7Cmean%7Cprod%7Csign%7Csort%7Csqrt%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28rank%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28cbind%7Cfloor%7Clog10%7Cmatch%7Cnties%7Corder%7Cprank%7Cqtile%7Crange%7Crbind%7Cround%7Cscale%7Ctable%7Ctrunc%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28is%5C.na%7Cprint%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28cummax%7Ccummin%7Ccumsum%7Cis%5C.nan%7Ckeypos%7Cmedian%7Cnvalid%7Csignif%7Ctiepos%7Cunipos%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28format%7Cunique%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28as%5C.list%7Cceiling%7Ccumprod%7Chashfun%7Chashmap%7Cnunique%7Cramsort%7Csortfin%7Csortnut%7Csortql%7Csorttab%7Csortuni%7Csummary%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28length%3C-%7Cna%5C.count%7Corderdup%7Corderfin%7Corderkey%7Cordernut%7Corderpos%7Corderqtl%7Corderrnk%7Cordertab%7Cordertie%7Corderuni%7Corderupo%7Cquantile%7Cramorder%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28all%5C.equal%7Cis%5C.double%7Cis%5C.finite%7Cis%5C.sorted%7Cis%5C.vector%7Cmergesort%7Cquicksort%7Cradixsort%7Cshellsort%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28as%5C.double%7Cidentical%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28as%5C.logical%7Cduplicated%7Chashmaptab%7Chashmapuni%7Chashmapupo%7Cmergeorder%7Cquickorder%7Cradixorder%7Cshellorder%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28as%5C.integer%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28is%5C.infinite%7Cas%5C.bitstring%7Cas%5C.integer64%7Cramsortorder%7Csortorderdup%7Csortorderkey%7Csortorderpos%7Csortorderrnk%7Csortordertab%7Csortordertie%7Csortorderuni%7Csortorderupo%7Cmergesortorder%7Cquicksortorder%7Cradixsortorder%7Cshellsortorder%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5Cb%28as%5C.data%5C.frame%7Cas%5C.character%29%5B.%5Dinteger64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5B.%5Dcache_integer64%2F+-path%3A.rd+-path%3Ahighlevel64.R&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2Fas%5C.integer64%5C.%28factor%7CNULL%29%2F&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2Fas%5C.integer64%5C.%28bitstring%7Ccharacter%7Cdouble%7Cinteger%7Clogical%29%2F&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2Fprint%5C.bitstring%2F&type=code

https://github.com/search?q=lang%3AR+-repo%3Ar-lib%2Fbit64+-repo%3Acran%2Fbit64+-repo%3ADavisVaughan%2Fbit64+-repo%3AMichaelChirico%2Fbit64+-repo%3AQuLogic%2Fbit64+%2F%5B%5Ea-z0-9._%24%5D%28%5B%5E%3A%5D%3A%7C%25in%25%7Cis.double%7Cmatch%7Corder%7Crank%29%5C.default%5B%60%22%27%5D%3F%5Cs*%5B%2C%28%29%5Cn%5D%2F+-path%3A.Rd&type=code

This was referenced Oct 16, 2024
Closed
Merged
@MichaelChirico MichaelChirico added this to the 4.7.0 milestone Jan 30, 2025
This was referenced Jan 31, 2025
Merged
Merged
@MichaelChirico
Copy link
Collaborator Author

Confirmed that none of the "2nd generation" of names to be un-exported (abs.integer64, ..., unique.integer64 above) are affected by the issue with primitives that hampered the "proper" processing of the "1st generation", so we can proceed as planned with those in the next release.

This was referenced Jan 31, 2025
Closed
Open
Closed
Open
Open
Open
Open
Open
Open
Open
Open
Closed
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
This was referenced Jan 31, 2025
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
@MichaelChirico
Copy link
Collaborator Author

All GitHub/CRAN users of exported S3 methods slated for deprecation beginning in the next release have now been notified. That's all I'll do during this release, pending feedback from downstreams on the plan.

@MichaelChirico MichaelChirico modified the milestones: 4.7.0, 4.8.0 Jan 31, 2025
m-pilarski added a commit to m-pilarski/chirp that referenced this issue Jan 31, 2025
@m-pilarski
See r-lib/bit64#76
e0b2848
@MichaelChirico MichaelChirico mentioned this issue Feb 1, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MichaelChirico