(In)Completeness of the R Documentation
Posted: Thu Oct 31, 2024 10:41 am
Hi guys
I am currently in the process of finishing up my module and writing the documentation. During this process I noticed that in the R documentation of the package under "Usage", for arguments that have a dropdown-style string-selector (e.g. the direction of the hypothesis, which can be "less", "two.sided" or "greater") the documentation only shows the default value instead of all possible values:
It's not a big deal, as I can just name the options under "Arguments". But it might be a bit confusing for R users, as usually all options of the argument are listed under "Usage". As an example for `?stats::binom.test()`
No doubt there is a technical explanation for this behavior. Just wanted to point it out.
Best,
Dan
I am currently in the process of finishing up my module and writing the documentation. During this process I noticed that in the R documentation of the package under "Usage", for arguments that have a dropdown-style string-selector (e.g. the direction of the hypothesis, which can be "less", "two.sided" or "greater") the documentation only shows the default value instead of all possible values:
Code: Select all
function(
data,
alternative = "two.sided"
)
Code: Select all
binom.test(x, n, p = 0.5,
alternative = c("two.sided", "less", "greater"),
conf.level = 0.95)
Best,
Dan