tamnva / R-SWAT

This is an interactive web-based app for parallel parameter sensitivity, calibration, and uncertainty analysis with the Soil and Water Assessment Tool (SWAT and SWAT+)
GNU General Public License v3.0
56 stars 24 forks source link

comments from CRAN submission - TODO #73

Open tamnva opened 6 months ago

tamnva commented 6 months ago

Please rather use the Authors@R field and declare Maintainer, Authors and Contributors with their appropriate roles with person() calls. e.g. something like: Authors@R: c(person("Alice", "Developer", role = c("aut", "cre","cph"), email = "alice.developer@some.domain.net"), person("Bob", "Dev", role = "aut") )

The Description field is intended to be a (one paragraph) description of what the package does and why it may be useful. Please add more details about the package functionality and implemented methods in your Description text.

If there are references describing the methods in your package, please add these in the description field of your DESCRIPTION file in the form authors (year) authors (year) authors (year, ISBN:...) or if those are not available: 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")

Please always explain all acronyms in the description text. -> SWAT/SWAT+

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: dds.Rd: \value userObjFunction.Rd: \value userReadSwatOutput.Rd: \value

You have examples for unexported functions. Please either omit these examples or export these functions. Examples for unexported function observedToList() in: observedToList.Rd readFileContent() in: readFileContent.Rd simToList() in: simToList.Rd

Please make sure that you do not change the user's options, par or working directory. If you really have to do so within functions, please ensure with an immediate call of on.exit() that the settings are reset when the function is exited. e.g.: ... oldwd <- getwd() # code line i on.exit(setwd(oldwd)) # code line i+1 ... setwd(...) # somewhere after ... e.g.: -> R/runSWATpar.R; R/saveOutput.R If you're not familiar with the function, please check ?on.exit. This function makes it possible to restore options before exiting a function even if the function breaks. Therefore it needs to be called immediately after the option change within a function.

Please do not modify the global environment (e.g. by using <<-) in your functions. This is not allowed by the CRAN policies. -> inst/R-SWAT/server.R

Please fix and resubmit.

tamnva commented 6 months ago

I am fixing these issues in this branch https://github.com/tamnva/R-SWAT/tree/CRAN_check