DARF framework documentation!

This framweork can be used to plot datasets in pythong without repeating the same code over and over again. The framework is based on Seaborn and Matplotlib library and is designed to be flexible and easy to use. The plots can be easily tuned to more spohisitcated with custom setups if necessary. The main usage of this library is for scientific pubblications where given the same data sometimes you just wanted to move the legend or change the font without having to look into the codebase or hack the plot.

This application is ment to be used with configuration .ini files, in oreder to produce plots without writing python code. A minimal example is the following configuration that can be saved in a file conf.ini

[penguins]
type=dataset
origin=Online
value=penguins

[penguin-plot]
type=plot
value=boxplot
dataset=penguins
kwargs='x':'species', 'y': 'bill_length_mm'

Run darf using the just created configuration

darf -c conf.ini

DARF is going to generate the following plot:

Refer to the plot section for more information on how to generate more complex figures. The dataset section on the opposite provides information on how to generate and manipulate datasets.

Using this framework

Installation: How to install this tool in your machine.
CLI Usage: How to use this tool from the CLI without need to write code.
API Usage: How to include this library into your code for easy plotting.
Customization: How to include new functions into the framework to personalize your plots.
Features: List of supported features and how to use them.
Examples package: A broader list of examples of how to use the framework.

Dataset Manipulation

Dataset: How to datasets are loaded into the framwork
Dataset Operations: How to manipulate the datasets
Dataset Forking: How to copy and modify an already loaded dataset

Plot Generation

Plot: How to generate simple plots
Plot level customization: Available customization options that applies to all generated plots
Figure level customization: Available customization options applicable to plots individually
User Defined Plot Functions: How to include new functions into the framework to personalize your plots.

Development

Contributing: How to contribute changes to the framework.
Development Guidelines: Guidelines the theme developers use for developing and testing changes.
Change Log: The framework development changelog.