Skip to content
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

update readme #1

Merged
merged 3 commits into from
Dec 8, 2017
Merged

update readme #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d26019f
update readme
dehann Nov 28, 2017
beffce1
final update to Readme
dehann Nov 29, 2017
cbec5bc
more tests
dehann Nov 30, 2017
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
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# KernelDensityEstimatePlotting.jl

[![Build Status](https://travis-ci.org/dehann/KernelDensityEstimatePlotting.jl.svg?branch=master)](https://travis-ci.org/dehann/KernelDensityEstimatePlotting.jl)
[![codecov.io](https://codecov.io/github/dehann/KernelDensityEstimatePlotting.jl/coverage.svg?branch=master)](https://codecov.io/github/dehann/KernelDensityEstimatePlotting.jl?branch=master)

[![KernelDensityEstimatePlotting](http://pkg.julialang.org/badges/KernelDensityEstimatePlotting_0.6.svg)](http://pkg.julialang.org/?pkg=KernelDensityEstimatePlotting&ver=0.6)

This package provides the plotting functionality for the [KernelDensityEstimate.jl](https://github.com/dehann/KernelDensityEstimate.jl) package, and currently only supports the Gadfly back-end.

This package is also used extensively by the [RoME.jl](https://github.com/dehann/RoME.jl) package.
This package is also used extensively by the [RoMEPlotting.jl](https://github.com/dehann/RoMEPlotting.jl) package.

# Install

This package will be registered in the future, but until then please install with:
```julia
Pkg.clone("https://github.com/dehann/KernelDensityEstimatePlotting.jl")
```

# Usage

Please see examples on [KernelDensityEstimate.jl](https://github.com/dehann/KernelDensityEstimate.jl).
12 changes: 12 additions & 0 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,17 @@ using Colors

# check for errors on plotting code
p = kde!(rand(100));
q = kde!(rand(100).+1.0);

plotKDE([p],c=["red"]);
plot(p);

plot([p;q])
plot([p;q], c=["red";"green"])

p2 = kde!(rand(3,100));
q2 = kde!(rand(3,100).+1.0);

plot(p2);
plot([p2;q2]);
plot([p2;q2];c=["red";"green"],levels=3);