srlanalytics / bdfm

Bayesian dynamic factor model estimation and predictive statistics including nowcasting and forecasting
MIT License
5 stars 6 forks source link

R CMD check results #2

Closed christophsax closed 5 years ago

christophsax commented 5 years ago

Run devtools::check() to perform R CMD check and the tests included in the package. R CMD check currently detects a few problems.

In the long run, we should get rid of all of these problems, this is required by CRAN. In the short run, we should get rid of the 3 warnings, in order to pass the checks on travis (to be implemented). Two warnings are straightforward, related to documentation, but we need to discuss the third one:

Compilation used the following non-portable flag(s):
  ‘-Wdate-time’ ‘-Werror=format-security’ ‘-Wformat’

Any idea how we could get rid of it?

Output of the R CMD check:

R CMD check results
0 errors | 3 warnings | 4 notes
checking for missing documentation entries ... WARNING
Undocumented code objects:
  ‘AnyNA’ ‘DayOfWeek’ ‘NumNA’ ‘Predetermined.d’ ‘Predetermined.m’
  ‘Y_sub’ ‘mlDFM’
All user-level objects in a package should have documentation entries.
See chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.

checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'BDFM'
  ‘Bp’ ‘Hp’ ‘ITC’

Functions with \usage entries need to have the appropriate \alias
entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
See chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.

checking compilation flags used ... WARNING
Compilation used the following non-portable flag(s):
  ‘-Wdate-time’ ‘-Werror=format-security’ ‘-Wformat’

checking for hidden files and directories ... NOTE
Found the following hidden files and directories:
  .travis.yml
These were most likely included in error. See section ‘Package
structure’ in the ‘Writing R Extensions’ manual.

checking installed package size ... NOTE
  installed size is  7.8Mb
  sub-directories of 1Mb or more:
    libs   7.6Mb

checking top-level files ... NOTE
File
  LICENSE
is not mentioned in the DESCRIPTION file.

checking R code for possible problems ... NOTE
Predetermined.d: no visible global function definition for ‘head’
Predetermined.d: no visible global function definition for ‘tail’
Predetermined.d: no visible global function definition for ‘dnorm’
Predetermined.d: no visible binding for global variable ‘holiday’
Predetermined.m: no visible binding for global variable ‘holiday’
Predetermined.m: no visible global function definition for
  ‘End_Next_Month’
SeasAdj_WE: no visible global function definition for ‘var’
Y_sub: no visible global function definition for ‘na.omit’
mlDFM: no visible global function definition for ‘na.omit’
mlDFM: no visible global function definition for ‘Matrix’
mlDFM: no visible global function definition for ‘Diagonal’
mlDFM: no visible global function definition for ‘sparseMatrix’
Undefined global functions or variables:
  Diagonal End_Next_Month Matrix dnorm head holiday na.omit
  sparseMatrix tail var
Consider adding
  importFrom("stats", "dnorm", "na.omit", "var")
  importFrom("utils", "head", "tail")
to your NAMESPACE file.
Warning message:
roxygen2 requires Encoding: UTF-8 
srlanalytics commented 5 years ago

Not at all sure where

 Compilation used the following non-portable flag(s):
   ‘-Wdate-time’ ‘-Werror=format-security’ ‘-Wformat’

but I'll thrash around in the files a bit and see if I can figure it out. The Rcpp build generates a lot of stuff, so it might be something in there... we'll see.

christophsax commented 5 years ago

I did not see it on travis, so this may be just something of my local linux installation. Don't worry for the moment.

But we need to fix the other two warnings.