/uruz

Primary LanguageRubyMIT LicenseMIT

Build Status

Uruz

This gem performs simple calculations VO2max and soon also of BMI

Installation

Add this line to your application's Gemfile:

gem 'uruz'

And then execute:

$ bundle

Or install it yourself as:

$ gem install uruz

Usage

To perform the calculation VO2Max

Calculate VO2max. ml(kg.min)-1

result = Uruz::Vo2max.calculate(distance)
Variable Type
distance Float
result Float

Classification based in result of VO2max. ml(kg.min)-1

classification = Uruz::Vo2max.classification(distance, age, gender)
Variable Type
distance Float
age Integer
gender Simble (:male, :female)
classification Simble (:very_weak, :weak, :middle, :good, :excellent, :higher)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/uruz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.