Skip to content

[R-pkg-devel] Package PowerSDI NOTES

5 messages · Gabriel Constantino Blain, Avraham Adler, Ivan Krylov +2 more

Original
Gabriel Constantino Blain
# 
Dears,
I submitted my R package to CRAN.
However, it didn't pass the CRAN checks because of 2 notes:
Note 1:
Flavor: r-devel-linux-x86_64-debian-gcc, r-devel-windows-x86_64
Check: CRAN incoming feasibility, Result: NOTE
  Maintainer: 'Gabriel Constantino Blain <gabriel.blain at sp.gov.br>'
  New submission
    Possibly misspelled words in DESCRIPTION:
    EP (14:45)
    NASAPOWER (11:18)
    OperatSDI (12:9)
    PowerSDI (7:18, 13:9)
    SPEI (3:31, 7:50, 10:20)
    SPI (3:23, 7:42, 10:12)
    ScientSDI (9:19)
    evapotranspitation (13:44)
    subperiods (15:76)
Note 2:
Flavor: r-devel-windows-x86_64
Check: examples, Result: NOTE
  Examples with CPU (user + system) or elapsed time > 10s
             user system elapsed
  ScientSDI 82.71   0.75   88.00
  Reference 29.75   0.05   29.80
  Accuracy  10.02   1.11   11.12
Flavor: r-devel-linux-x86_64-debian-gcc
Check: examples, Result: NOTE
  Examples with CPU (user + system) or elapsed time > 5s
              user system elapsed
  ScientSDI 52.674  0.176  57.765
  Reference 20.749  0.148  20.898
  Accuracy   6.001  0.024   6.024

Regarding note 1, not all the words are misspelled,
EP, SPI and SPEI are acronyms
OperatSDI and ScientSDI are functions of my package
PowerSDI is the name of my package's name
 NASAPOWER is the project's name.

Regarding note 2, I don't know what's wrong. Is it related to the time to run the examples (>5s)? If is it so, it is not an error. There are so many calculations that it does take some time to do it.

The package is available at https://github.com/gabrielblain/PowerSDI
I really appreciate any help you can provide.
Best regards
Gabriel
Avraham Adler
# 
Hello, Gabriel. 

CRAN policy is to rarely, if ever, allow long-running examples. It would be best if you could give an example of the function which requires as little run time as possible. Perhaps pre-compute some stages?

Avi

Sent from my iPhone
Ivan Krylov
# 
On Tue, 18 Jul 2023 16:37:46 +0000
Gabriel Constantino Blain <gabriel.blain at sp.gov.br> wrote:

            

      
      
      
    

        
This is fine, especially if you add a comment to your package
submission.

            

      
      
      
    

        
I'm sorry, but it's a policy of CRAN to require examples that run "for
no more than a few seconds each":
https://cran.r-project.org/web/packages/policies.html

I know it may be non-trivial, but I hope it's possible to reduce the
amount of data processed by your examples until they take around 5
seconds or less on a typical computer. For example, could it be
possible to reduce the date range of the ScientSDI example to one year
and/or increase(?) the TS parameter?

  
    

      
      
    

  


  


      

    

    

      
      

        


  

        

      Duncan Murdoch
    

    

      
      #
    

  


  

      
On 18/07/2023 12:37 p.m., Gabriel Constantino Blain wrote:

            

      
      
      
    

        
Writing R Extensions section 1.1.1 describes some rules for quoting 
non-English words.  I think they imply OperatSDI, ScientSDI and PowerSDI 
should be in single quotes.  I am not sure whether that also applies to 
your other non-English words.

Duncan Murdoch

            

      
      
      
    

        

      
      
    

  
  


  


      

    

    

      
      

        


  

        

      Ben Bolker
    

    

      
      #
    

  


  

      
See also

https://ropensci.org/blog/2022/01/21/ropensci-news-digest-january-2022/#to-quote-or-not-to-quote-non-existing-words-in-description

https://stat.ethz.ch/R-manual/R-patched/library/utils/html/aspell-utils.html

        
On 2023-07-18 3:11 p.m., Duncan Murdoch wrote: