RLetters

Build Status Dependency Status Coverage Status

Homepage: http://charlespence.net/rletters
Git: http://github.com/cpence/rletters
Author: Charles Pence
Contributors: See Contributors section below
Copyright: 2011–2013
License: MIT License
Latest Version: v1.1 beta
Release Date: September 24, 2013

RLetters is an application designed to let users perform complex searches as well as digital-humanities and text-mining analysis tasks on a corpus of journal articles.

Features

Complex search

The Solr backend on which RLetters is based allows for a number of complicated searching operations:

Text analysis

RLetters allows users to save the results of a given search as a "dataset." This produces a saved record that users can return to later in order to perform text analysis tasks.

While text analysis tasks are a current area of active development in RLetters, currently the following are available:

Support for web and library standards

RLetters provides support for the following web and library standards:

And you can export bibliographic data in the following standard formats:

Cutting-edge development and maintenance tools

RLetters doesn't leave your developers out in the cold, either. We've got support for the following features that make development, deployment, maintenance, and monitoring easier:

Installation / Deployment

See our detailed installation and deployment guide for instructions. For the extremely impatient:

# Install Ansible 1.3+ from your local package manager
# Establish passwordless SSH with passwordless sudo to your server running RHEL/CentOS 6
git clone git://github.com/cpence/rletters.git

cd rletters/deploy
cp hosts.example hosts
$EDITOR hosts
  # Point all these paths at your server
ansible-playbook -i hosts site.yml

# Open up a web browser to http://YOUR_SITE/admin/
  # Log in with admin@example.com / password
  # CHANGE THOSE DEFAULT CREDENTIALS
  # Configure any other settings that strike your fancy

Contributors / Support

Special thanks to all contributors for submitting patches. A full list of contributors including their patches can be found at:

https://github.com/cpence/rletters/contributors

Also, several features of RLetters wouldn't be possible without the excellent work of other Ruby programmers. Thanks in particular to those behind Ansible, RSolr and RSolr::Ext, stanford-core-nlp, citeproc-ruby, and bibtex-ruby. The stop lists found in db/seeds/stoplists are released under the BSD license by the Apache Lucene project.

Charles Pence and Grant Ramsey were supported in the development of RLetters by the National Evolutionary Synthesis Center (NESCent), NSF #EF-0905606.

National Science Foundation National Evolutionary Synthesis Ceter

Copyright

RLetters © 2011–2013 by Charles Pence. RLetters is licensed under the MIT license. Please see the COPYING document for more information.