Skip to content

Commit

Permalink
Add notes on resubmission
Browse files Browse the repository at this point in the history
  • Loading branch information
kylebittinger committed Jan 15, 2020
1 parent 962faf4 commit 23df251
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,36 @@
## Resubmission notes

Thank you to Martina Schmirl for the helpful comments on our initial
submission. We have improved the documentation and are resubmitting.

"Please always write package names, software names and API names in
single quotes in title and description. e.g: --> 'vegan'"

Done.

"If there are references describing the methods in your package, please
add these in the description field of your DESCRIPTION file in the form..."

Thank you, we have no such references.

"Please add \value to .Rd files regarding exported methods and explain
the functions results in the documentation.
e.g. kullback_leibler_divergence.Rd"

We have added \value{} to all exported functions.

"In some functions the return value is NaN, however, it would be better
to use stop() as it "stops execution of the current expression and
executes an error action.". e.g. kullback_leibler_divergence.Rd
Please change the code (or mention it in \value{} in the documentation)."

We have carefully considered whether to use stop() in various edge cases.
We call stop() when the type of input is not correct or when the input size is
wrong, for example in match_to_tree() and minkowski(). However, for many of
the functions here, the result is undefined even though the input is
considered valid. In this case, we return NaN and have documented it in
\value{}.

## Test environments
* local OS X install, R 3.6.1
* ubuntu 14.04 (on travis-ci), R 3.6.1
Expand Down

0 comments on commit 23df251

Please sign in to comment.