.. _l-functions:

Functions
=========

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


Summary
+++++++

+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                      | class parent | truncated documentation                                                                                                                                                                                                               |
+===============================================================================================+==============+=======================================================================================================================================================================================================================================+
| :func:`_read_geopandas_from_bytes <papierstat.datasets.carreau._read_geopandas_from_bytes>`   |              | Returns a :epkg:`GeoDataFrame` from two sequences of bytes, one for file *.mif*, one from file *.mid*. Unfortunately, ...                                                                                                             |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_setup_hook <papierstat._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 <papierstat.check>`                                                              |              | Checks the library is working. It raises an exception. If you want to disable the logs:                                                                                                                                               |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`create_tiny_graph <papierstat.datasets.graph.create_tiny_graph>`                       |              | Graphe très petit. La fonction retourne une matrice dans laquelle chaque élément représente la probabilité de passer ...                                                                                                              |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`duration_selling <papierstat.datasets.duration.duration_selling>`                      |              | Construit un jeu de données artificiel qui simule des paquets préparés par un magasin. Chaque paquet est préparé dès ...                                                                                                              |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_data_folder <papierstat.datasets.data_helper.get_data_folder>`                     |              | Retourne le répertoire de données inclus dans ce module.                                                                                                                                                                              |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_geojson_countries <papierstat.datasets.geojson.get_geojson_countries>`             |              | Retourne les contours des pays au format :epkg:`GeoJSON`. Les données sont disponibles dans le répertoire `data <https://github.com/sdpython/papierstat/tree/master/src/papierstat/datasets/data>`_ ...                               |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`line2d <papierstat.datasets.dummies.line2d>`                                           |              | Simule un jeu de données pour une régression linéaire. Notebooks associés à ce jeu de données :                                                                                                                                       |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`list_notebooks <papierstat.datasets.documentation.list_notebooks>`                     |              | Retourne les notebooks qui contiennent *name* dans leur nom.                                                                                                                                                                          |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`list_notebooks_rst_links <papierstat.datasets.documentation.list_notebooks_rst_links>` |              | Retourne une liste de notebooks au format :epkg:`rst`.                                                                                                                                                                                |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_adult_dataset <papierstat.datasets.cat.load_adult_dataset>`                       |              | Retourne le jeu de données `Adult Data Set <https://archive.ics.uci.edu/ml/datasets/adult>`_. Les variables sont ...                                                                                                                  |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_biased <papierstat.datasets.biased.load_biased>`                                  |              | Retourne un jeu de données biaisé.                                                                                                                                                                                                    |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_carreau_from_zip <papierstat.datasets.carreau.load_carreau_from_zip>`             |              | Retourne un exemple de données carroyées. Les données sont disponibles dans le répertoire `data <https://github.com/sdpython/papierstat/tree/master/ src/papierstat/datasets/data>`_. ...                                             |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_dbf_from_zip <papierstat.datasets.carreau.load_dbf_from_zip>`                     |              | Loads a *.dbf* file compressed into a zip file. It only takes the first *.dbf* file from the zip.                                                                                                                                     |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_enedis_dataset <papierstat.datasets.enedis.load_enedis_dataset>`                  |              | Retourne des données extraites du site :epkg:`Enedis` : `Production électrique annuelle par filière à la maille commune <https://data.enedis.fr/explore/dataset/production-electrique-par-filiere-a-la-maille-commune/export/>`_. ... |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_movielens_dataset <papierstat.datasets.movies.load_movielens_dataset>`            |              | Retourne un jeu de données extrait de la page `movielens <https://grouplens.org/datasets/movielens/>`_. Notebooks ...                                                                                                                 |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_search_engine_dataset <papierstat.datasets.search.load_search_engine_dataset>`    |              | Retourne un très petit échantillon tiré de `Microsoft Learning to Rank Datasets <https://www.microsoft.com/en-us/research/project/mslr/?from=http%3A%2F%2Fresearch.microsoft.com%2Fen-us%2Fprojects%2Fmslr%2F>`_. ...                 |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_sentiment_dataset <papierstat.datasets.sentiment.load_sentiment_dataset>`         |              | Retourne un ensemble de phrases en anglais avec assorties d'un sentiment positif ou négatif. Source : `Sentiment Labelled Sentences Data Set <https://archive.ics.uci.edu/ ml/datasets/Sentiment+Labelled+Sentences>`_. ...           |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_shapes_from_zip <papierstat.datasets.carreau.load_shapes_from_zip>`               |              | Loads a *.mif* and a *.mid* file compressed into a zip file. It only takes the first *.mid* and *.mif* files from the ...                                                                                                             |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_titanic_dataset <papierstat.datasets.titanic.load_titanic_dataset>`               |              | Retourne le jeu de données Titanic, Data obtained from `biostat.mc.vanderbilt.edu/DataSets <http://biostat.mc.vanderbilt.edu/DataSets>`_. ...                                                                                         |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_tweet_dataset <papierstat.datasets.tweets.load_tweet_dataset>`                    |              | Retourne quelques tweets extrait en 2016. Les données sont disponibles dans le répertoire `data <https://github.com/sdpython/papierstat/tree/master/src/papierstat/datasets/data>`_. ...                                              |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_wine_dataset <papierstat.datasets.wines.load_wine_dataset>`                       |              | Retourne le jeu de données `wine quality <https://archive.ics.uci.edu/ml/datasets/wine>`_. Notebooks associés à ...                                                                                                                   |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_wines_dataset <papierstat.datasets.wines.load_wines_dataset>`                     |              | Retourne le jeu de données `wines quality <https://archive.ics.uci.edu/ml/datasets/wine+quality>`_. Notebooks associés ...                                                                                                            |
+-----------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+