Skip to content

docs: Document weights argument for kde function #141

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Document weights argument for kde function #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ optional keyword arguments are
`kernel_dist` function.
* `bandwidth`: the bandwidth of the kernel. Default is to use Silverman's
rule.
* `weights`: `StatsBase.Weights` vector specifying weights for each observation (defaults to uniform weights).

The `UnivariateKDE` object `U` contains gridded coordinates (`U.x`) and the density
estimate (`U.density`). These are typically sufficient for plotting.
Expand Down
1 change: 1 addition & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ optional keyword arguments are
`kernel_dist` function.
* `bandwidth`: the bandwidth of the kernel. Default is to use Silverman's
rule.
* `weights`: `StatsBase.Weights` vector specifying weights for each observation (defaults to uniform weights).

The `UnivariateKDE` object `U` contains gridded coordinates (`U.x`) and the density
estimate (`U.density`). These are typically sufficient for plotting.
Expand Down
Loading