Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
asinghvi17 authored Mar 10, 2024
1 parent 6494a78 commit d259857
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,26 @@
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://asinghvi17.github.io/SwarmMakie.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://asinghvi17.github.io/SwarmMakie.jl/dev/)
[![Build Status](https://github.com/asinghvi17/SwarmMakie.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/asinghvi17/SwarmMakie.jl/actions/workflows/CI.yml?query=branch%3Amain)

Beeswarm plots in Makie!

## Quick start

The entry point to this package is the `beeswarm` recipe, which accepts input the same way `scatter` does in all respects -- plus a keyword `algorithm`, which specifies the beeswarm algorithm!

```julia
using SwarmMakie, CairoMakie
ys = rand(150)
beeswarm(ones(length(ys)), ys)
```
![download-22](https://github.com/asinghvi17/SwarmMakie.jl/assets/32143268/5b422b52-0017-4bd2-8c61-22ad195266b1)

```julia
using SwarmMakie, CairoMakie
xs = rand(1:4, 500)
ys = randn(500)
beeswarm(xs, ys; color = xs)
```
![download-23](https://github.com/asinghvi17/SwarmMakie.jl/assets/32143268/861f36f9-d431-41a3-8823-6d96edac0017)

See the docs for more!

0 comments on commit d259857

Please sign in to comment.