Abstractor is a Rails engine gem for deriving discrete data points from narrative text via natural language processing. The gem includes a user interface to present the abstracted data points for confirmation/revision by curator.

Reader's note: this README uses YARD markup to provide links to Abstractor's API documentation. If you aren't already, consider reading it on rubydoc.info so that the links will be followable.


Gem Version


Abstractor works with:

  • Ruby 1.9.3, 2.0.0 and 2.1.1
  • Rails 3.2 (not Rails 4.0 or later yet)

Some key dependencies are:


Add abstractor to your Gemfile:

gem 'abstractor'

Also add the paper_trail gem to your Gemfile (if it is not already there):

gem 'paper_trail'

Bundle, install, and migrate:

  • bundle install
  • bundle exec rails g abstractor:install
  • bundle exec rake db:migrate
  • bundle exec rake abstractor:setup:system

Install the paper_trail gem (if it is not already installed in your application).

  • bundle exec rails g paper_trail:install
  • bundle exec rake db:migrate