Add documentation to dtm #29
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dlm
reviewed
Feb 23, 2019
| return (Dtm(knnDistance = knnDistance, weightBound = weightBound, r = r)) | ||
|
|
||
| # with weight | ||
| } else { | ||
| # establish the weightbound and weight parameters to be used in final DtmWeight function |
There was a problem hiding this comment.
These and the next set are great comments. The code below is somewhat non-obvious and the comments make it very easy to read what is happening.
Streamlined comments again in similar manner to previous PR
roxygen needs a title to make nice documentation reliably
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Roxygen style comments for parameters and return value, comments in code