.. _l-functions:

Functions
=========

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| function                                                                        | class parent | truncated documentation                                                                                                    |
+=================================================================================+==============+============================================================================================================================+
| :func:`_setup_hook <manydataapi._setup_hook>`                                   |              | if this function is added to the module, the help automation and unit tests call it first before anything goes on ...      |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`check <manydataapi.check>`                                               |              | Checks the library is working. It raises an exception.                                                                     |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`daily_timeseries <manydataapi.plotting.dummies.daily_timeseries>`        |              | Creates a random positive timeseries.                                                                                      |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`dataframe_to <manydataapi.parsers.dataframe_helper.dataframe_to>`        |              | Exports a dataframe into the write format. The function uses the file extension to choose the right exporter.              |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`dummy_ct1 <manydataapi.parsers.ct1.dummy_ct1>`                           |              | Returns a dummy file for format ``CT1``.                                                                                   |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`get_index_date <manydataapi.plotting.timeseries.get_index_date>`         |              | Returns the only column date. Raises an exception otherwise.                                                               |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`get_new_column <manydataapi.plotting.timeseries.get_new_column>`         |              | Get a new column which does not exists in df.                                                                              |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`main <manydataapi.__main__.main>`                                        |              | Implements ``python -m manydataapi <command> <args>``.                                                                     |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`plot_aggregated_ts <manydataapi.plotting.timeseries.plot_aggregated_ts>` |              | Plots an aggregated time series by a period of time.                                                                       |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`read_ct1 <manydataapi.parsers.ct1.read_ct1>`                             |              | Parses a file or a string which follows a specific format called `CT1`. See function :func:`dummy_ct1` for an example. ... |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`read_folder <manydataapi.parsers.folders.read_folder>`                   |              | Applies the same parser on many files in a folder.                                                                         |
+---------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------+