JonasMoss / kdensity

An R package for kernel density estimation with parametric starts and asymmetric kernels.
Other
14 stars 4 forks source link

[JOSS Review]: README.rmd minor comments/suggestions #57

Closed trashbirdecology closed 5 years ago

trashbirdecology commented 5 years ago

JOSS Review 1566

"This is a good idea because the resulting estimator will be better than an ordinary kernel density estimator whenever the true density is close to your suggestion; and the estimator can be superior to the ordinary kernel density estimator even when the suggestion is pretty far off.">

Suggest editing this sentence by

The following is in the Section Installation but is useage and not installation:

| Call the library function and use it just like stats:density, but with optional additional arguments.

library("kdensity")
plot(kdensity(mtcars$mpg, start = "normal"))

Clarify what the 'return value' is in:

"Since the return value of kdensity is a function, it is callable, as in:"


Revise the bold in sentence:

"The following example uses the data set plots both a gamma-kernel density estimate with a gamma start (black), the fully parametric gamma density (red), and an ordinary density estimate (blue)."


Consider editing for grammar in the parts in bold:

If you encounter a bug, have a feature request or need some help, don’t hesitate to open an issue. If you want to contribute, make a pull request. This project follows a Contributor Code of Conduct.

JonasMoss commented 5 years ago

Thanks! Updated in b96ec08bdb9a90f3364b7ecf090ab69ee8b13d0c.