Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

organize functions in nms4r, supplement with parameter documentation #59

Open
superjai opened this issue Nov 4, 2020 · 3 comments
Open
Assignees

Comments

@superjai
Copy link
Collaborator

superjai commented Nov 4, 2020

Hey @bbest - I have gone through and fully documented nms4r as best I could. Considering that the package is well over a thousand lines now, I was having real trouble keeping track of what was what. There certainly is room for improvement, but at least the first pass is done. I documented every single function using the guidance provided here.

As part of going through this whole package, I found several functions that were no longer being used. I deleted all of the unused functions and I was able to prune out quite a bit.

There were a few places in the code I drew a complete blank, where in particular I could use your assistance. There were a few functions I couldn't figure out at all and a few variables I couldn't understand. I flagged those points within spatial.r. On lines where I need your input, I wrote in "BEN". So just do a search for BEN in spatial.R and you'll find all of the places to jump in.

@bbest
Copy link
Contributor

bbest commented Nov 6, 2020

This will also relate to #60 in that we should not only group functions under headers in the References listing of the pkgdown website, but also in different *.R files besides all in spatial.R. So see #60 for ideas on grouping.

@bbest bbest changed the title help needed with nms4r documentation organize functions in nms4r, supplement with parameter documentation Nov 6, 2020
@bbest bbest closed this as completed Nov 6, 2020
@bbest bbest reopened this Nov 6, 2020
@superjai
Copy link
Collaborator Author

Hey @bbest - I have managed to clear up some of the uncertainties, but there are still a few outstanding blanks with your name on it. Do note that there are now four R files in the R folder not just the one spatial.R.

@bbest
Copy link
Contributor

bbest commented Jan 8, 2021

I'm on it with the awesome new Find in Files function in RStudio:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants