User Guide

User Guide #

Guide Overview #

We are in the process of developing a user guide to help people use Boxer.

At present there are four pieces:

  1. A Get started tutorial help you get familiar with the use of Boxer system
  2. A View descriptopn page help you get familiar with each view in Boxer system
  3. Instructions to prepare your own data for Boxer
  4. A guide of Make views provides basic concepts of creating views, saveing / loading views configurations.

The best way to learn how to use Boxer is to walk through the get started tutorial and read the guide in views manipulation. You can also learn the functions and detailed usage of each view in view descriptopn page.

Once you’re ready to try it yourself, look at the instructions on data preparation that will help you format your data so that it can be read by Boxer.

For more complex use, you could go to use cases that showcase different Boxer features on example data sets.

Tutorial Recommendation #

If you want to use boxer with your own data:

If you want to appreciate the key ideas:

If you are a developer: