bsaul/geex

CRAN maintainer comments

bsaul opened this issue · 0 comments

bsaul commented

A CRAN maintainer wrote:

Please write references in the description of the DESCRIPTION file in
the form
authors (year) <doi:...>
authors (year) <arXiv:...>
authors (year, ISBN:...)
or if those are not available: authors (year) <https:...>
with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for
auto-linking.
(If you want to add a title as well please put it in quotes: "Title")
Add the title and authors of the the corresponding Journal of 
Statistical Software paper.

  Found the following URLs which should use \doi (with the DOI name only):
    File 'geex-package.Rd':
      http://dx.doi.org/10.18637/jss.v092.i02

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 12 .Rd files, e.g.:
     coef-methods.Rd: \value
     compute_pairwise_sum_of_list.Rd: \value
     compute_sum_of_list.Rd: \value
     grab.Rd: \value
     grab_design_matrix.Rd: \value
     grab_fixed_formula.Rd: \value
     ...

\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 ensure that your functions do not write by default or in your 
examples/vignettes/tests in the user's home filespace (including the 
package directory and getwd()). This is not allowed by CRAN policies. -> 
inst/create_sample_data.R
Please omit any default path in writing functions. In your 
examples/vignettes/tests you can write to tempdir().

Please fix and resubmit.