{"id":13878204,"url":"https://github.com/ankane/breakout-ruby","last_synced_at":"2025-11-17T14:14:06.884Z","repository":{"id":56843070,"uuid":"402657294","full_name":"ankane/breakout-ruby","owner":"ankane","description":"Breakout detection for Ruby","archived":false,"fork":false,"pushed_at":"2025-06-16T21:41:15.000Z","size":54,"stargazers_count":46,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-27T11:56:38.594Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ankane.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-09-03T05:30:15.000Z","updated_at":"2025-06-16T21:41:19.000Z","dependencies_parsed_at":"2024-10-03T12:20:25.183Z","dependency_job_id":"da8610cf-80cf-4ea5-a2e6-2f8888737a59","html_url":"https://github.com/ankane/breakout-ruby","commit_stats":{"total_commits":25,"total_committers":1,"mean_commits":25.0,"dds":0.0,"last_synced_commit":"36b10ca932b8d415affc35fcdf5cb7350dc15722"},"previous_names":["ankane/breakout"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ankane/breakout-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankane%2Fbreakout-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankane%2Fbreakout-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankane%2Fbreakout-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankane%2Fbreakout-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ankane","download_url":"https://codeload.github.com/ankane/breakout-ruby/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ankane%2Fbreakout-ruby/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269699232,"owners_count":24461210,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-06T08:01:42.624Z","updated_at":"2025-11-17T14:14:01.846Z","avatar_url":"https://github.com/ankane.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Breakout Ruby\n\n:fire: [BreakoutDetection](https://github.com/twitter/BreakoutDetection) for Ruby\n\nLearn [how it works](https://blog.twitter.com/engineering/en_us/a/2014/breakout-detection-in-the-wild)\n\n[![Build Status](https://github.com/ankane/breakout-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/breakout-ruby/actions)\n\n## Installation\n\nAdd this line to your application’s Gemfile:\n\n```ruby\ngem \"breakout-detection\"\n```\n\n## Getting Started\n\nDetect breakouts in a time series\n\n```ruby\nseries = {\n  Date.parse(\"2025-01-01\") =\u003e 100,\n  Date.parse(\"2025-01-02\") =\u003e 150,\n  Date.parse(\"2025-01-03\") =\u003e 136,\n  # ...\n}\n\nBreakout.detect(series)\n```\n\nWorks great with [Groupdate](https://github.com/ankane/groupdate)\n\n```ruby\nseries = User.group_by_day(:created_at).count\nBreakout.detect(series)\n```\n\nSeries can also be an array without times (the index is returned)\n\n```ruby\nseries = [100, 150, 136, ...]\nBreakout.detect(series)\n```\n\n## Options\n\nPass options - default values below\n\n```ruby\nBreakout.detect(\n  series,\n  min_size: 30,        # minimum observations between breakouts\n  method: \"multi\",     # multi or amoc (at most one change)\n  degree: 1,           # degree of the penalization polynomial (multi only)\n  beta: 0.008,         # penalization term (multi only)\n  percent: nil,        # minimum percent change in goodness of fit statistic (multi only)\n  alpha: 2,            # weight of the distance between observations (amoc only)\n  exact: true          # exact or approximate median (amoc only)\n)\n```\n\n## Plotting\n\nAdd [Vega](https://github.com/ankane/vega) to your application’s Gemfile:\n\n```ruby\ngem \"vega\"\n```\n\nAnd use:\n\n```ruby\nBreakout.plot(series, breakouts)\n```\n\n## Credits\n\nThis library uses the C++ code from the [BreakoutDetection](https://github.com/twitter/BreakoutDetection) R package and is available under the same license.\n\n## References\n\n- [Leveraging Cloud Data to Mitigate User Experience from ‘Breaking Bad’](https://arxiv.org/abs/1411.7955)\n\n## History\n\nView the [changelog](https://github.com/ankane/breakout-ruby/blob/master/CHANGELOG.md)\n\n## Contributing\n\nEveryone is encouraged to help improve this project. Here are a few ways you can help:\n\n- [Report bugs](https://github.com/ankane/breakout-ruby/issues)\n- Fix bugs and [submit pull requests](https://github.com/ankane/breakout-ruby/pulls)\n- Write, clarify, or fix documentation\n- Suggest or add new features\n\nTo get started with development:\n\n```sh\ngit clone https://github.com/ankane/breakout-ruby.git\ncd breakout-ruby\nbundle install\nbundle exec rake compile\nbundle exec rake test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankane%2Fbreakout-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fankane%2Fbreakout-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankane%2Fbreakout-ruby/lists"}