getkeops / keops

KErnel OPerationS, on CPUs and GPUs, with autodiff and without memory overflows
https://www.kernel-operations.io
MIT License
1.02k stars 65 forks source link

New release of rkeops v2: minor additional modifications regarding cache directory management #373

Closed gdurif closed 1 month ago

gdurif commented 1 month ago

Following #369 and submission to CRAN, the CRAN team asked that the rkeops cache directory was removed entirely instead of being left empty after a cleanup.

gdurif commented 1 month ago

Submitted to CRAN

gdurif commented 1 month ago

Check report :

* using log directory ‘/srv/hornik/tmp/CRAN/rkeops.Rcheck’
* using R Under development (unstable) (2024-06-03 r86679)
* using platform: x86_64-pc-linux-gnu
* R was compiled by
    Debian clang version 18.1.5 (2)
    Debian flang-new version 18.1.5 (2)
* running under: Debian GNU/Linux trixie/sid
* using session charset: UTF-8
* checking for file ‘rkeops/DESCRIPTION’ ... OK
* this is package ‘rkeops’ version ‘2.2.3’
* package encoding: UTF-8
* checking CRAN incoming feasibility ... [5s/34s] NOTE
Maintainer: ‘Ghislain Durif <gd.dev@libertymail.net>’

New submission

Package was archived on CRAN

Possibly misspelled words in DESCRIPTION:
  Autodiff (2:46)

CRAN repository db overrides:
  X-CRAN-Comment: Archived on 2024-02-15 for policy violation.

  Misuse of ~/.cache/keops2.2.2.  Version 2.2.2 was removed.

Found the following (possibly) invalid URLs:
  URL: https://djsutherland.ml
    From: inst/doc/introduction_to_rkeops.html
          README.md
    Status: Error
    Message: Could not resolve host: djsutherland.ml
* checking package namespace information ... OK
* checking package dependencies ... OK
* checking if this is a source package ... OK
* checking if there is a namespace ... OK
* checking for executable files ... OK
* checking for hidden files and directories ... OK
* checking for portable file names ... OK
* checking for sufficient/correct file permissions ... OK
* checking serialization versions ... OK
* checking whether package ‘rkeops’ can be installed ... [6s/6s] OK
* checking package directory ... OK
* checking for future file timestamps ... OK
* checking ‘build’ directory ... OK
* checking DESCRIPTION meta-information ... OK
* checking top-level files ... OK
* checking for left-over files ... OK
* checking index information ... OK
* checking package subdirectories ... OK
* checking code files for non-ASCII characters ... OK
* checking R files for syntax errors ... OK
* checking whether the package can be loaded ... [1s/1s] OK
* checking whether the package can be loaded with stated dependencies ... [1s/1s] OK
* checking whether the package can be unloaded cleanly ... [1s/1s] OK
* checking whether the namespace can be loaded with stated dependencies ... [1s/1s] OK
* checking whether the namespace can be unloaded cleanly ... [1s/1s] OK
* checking loading without being on the library search path ... [1s/1s] OK
* checking whether startup messages can be suppressed ... [1s/1s] OK
* checking use of S3 registration ... OK
* checking dependencies in R code ... OK
* checking S3 generic/method consistency ... OK
* checking replacement functions ... OK
* checking foreign function calls ... OK
* checking R code for possible problems ... [8s/8s] OK
* checking Rd files ... [2s/2s] OK
* checking Rd metadata ... OK
* checking Rd line widths ... OK
* checking Rd cross-references ... OK
* checking for missing documentation entries ... OK
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... OK
* checking Rd contents ... OK
* checking for unstated dependencies in examples ... OK
* checking installed files from ‘inst/doc’ ... OK
* checking files in ‘vignettes’ ... OK
* checking examples ... [18s/18s] OK
* checking for unstated dependencies in ‘tests’ ... OK
* checking tests ... [2s/2s] OK
  Running ‘testthat.R’ [2s/2s]
* checking for unstated dependencies in vignettes ... OK
* checking package vignettes ... OK
* checking re-building of vignette outputs ... [7s/7s] OK
* checking PDF version of manual ... [6s/6s] OK
* checking HTML version of manual ... [4s/4s] OK
* checking for non-standard things in the check directory ... OK
* checking for detritus in the temp directory ... OK
* DONE
Status: 1 NOTE
gdurif commented 1 month ago

Message from CRAN after submission :

Please add \value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \value{No return value, called for side effects} or similar) Missing Rd-tags in up to 11 .Rd files, e.g.: complex.default.Rd: \value default.math.fun.Rd: \value install_rkeops.Rd: \value ...

You have examples for unexported functions. Please either omit these examples or export these functions. Examples for unexported function arithmetic.multiply.LazyTensor() in: check_keopscore.Rd *.ComplexLazyTensor() in: check_pykeops.Rd check_pykeops() in: fix_variables.Rd check_rkeops() in: get_inner_dim.Rd Arg.default() in: identifier.Rd atan2() in: preprocess_reduction.Rd ifelse() in: set_pykeops_build_dir.Rd ifelse.LazyTensor() in: set_pykeops_verbosity.Rd Im.LazyTensor() in: setup_pykeops.Rd

\dontrun{} should only be used if the example really cannot be executed (e.g. because of missing additional software, missing API keys, ...) by the user. That's why wrapping examples in \dontrun{} adds the comment ("# Not run:") as a warning for the user. Does not seem necessary. Please replace \dontrun with \donttest. Please unwrap the examples if they are executable in < 5 sec, or replace dontrun{} with \donttest{}.

Please fix and resubmit.