Quickstart
=========================================

------------------------
Getting Started    
------------------------

If not to be integrated into a workflow, **FinaleToolkit** is intended to be run directly from a terminal interface. 

You can open the terminal and typing the following command::

    $ finaletoolkit

------------------------
Importing Modules   
------------------------

The **FinaleToolkit** package itself is divided by its API functions.

FinaleToolkit has the following modules:

* `frag` - fragmentomic feature genereation
* `genome` - utilities for genome tracks
* `cli` - command line interface
* `utils` - utilities that simplify feature generation

You can load *all* fragmentomics functions by using the following command::

    >>> import finaletoolkit.frag as ft
    
If you want to load a *specific* function, you can do so by using the following:

Assuming we wanted to load the DELFI function::

    >>> from finaletoolkit.frag import delfi