stuartWagenius / mateable

Tools to Assess Mating Potential in Space and Time
0 stars 4 forks source link

Update functions to minimize user par disruption and update documentation #59

Closed amywaananen closed 1 year ago

amywaananen commented 1 year ago

Addresses comments from initial CRAN submission:

Please write TRUE and FALSE instead of T and F. Please don't use "T" or "F" as vector names.

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: plot3DPotential.Rd: \value plotPotential.Rd: \value

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.: ... oldpar <- par(no.readonly = TRUE) # code line i on.exit(par(oldpar)) # code line i + 1

Please always make sure to reset to user's options(), working directory or par() after you changed it in examples and vignettes and demos. -> inst/doc/investigateMatingScene.R