diff --git a/README.md b/README.md index 1bddb61..93d9ea5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Uplot +Create ASCII charts on the terminal with data from standard streams in the pipeline. + +:bar_chart: Powered by [UnicodePlot](https://github.com/kojix2/uplot) + :construction: Under development ## Installation @@ -10,12 +14,39 @@ gem install uplot ## Usage +### histogram + +```sh +ruby -r numo/narray -e "puts Numo::DFloat.new(1000).rand_norm.to_a" \ + | uplot hist --nbins 15 +``` + +``` + ┌ ┐ + [-4.5, -4.0) ┤ 1 + [-4.0, -3.5) ┤ 0 + [-3.5, -3.0) ┤ 1 + [-3.0, -2.5) ┤▇▇ 9 + [-2.5, -2.0) ┤▇▇▇ 15 + [-2.0, -1.5) ┤▇▇▇▇▇▇▇▇▇ 50 + [-1.5, -1.0) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 97 + [-1.0, -0.5) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 154 + [-0.5, 0.0) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 193 + [ 0.0, 0.5) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 165 + [ 0.5, 1.0) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 152 + [ 1.0, 1.5) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 86 + [ 1.5, 2.0) ┤▇▇▇▇▇▇▇▇▇ 51 + [ 2.0, 2.5) ┤▇▇▇▇ 21 + [ 2.5, 3.0) ┤▇ 3 + [ 3.0, 3.5) ┤ 2 + └ ┘ + Frequency +``` + ## Development ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/uplot. - ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).