.. _l-functions:

Functions
=========

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


Summary
+++++++

+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                                        | class parent | truncated documentation                                                                                                                                                                                                                       |
+=================================================================================================================================+==============+===============================================================================================================================================================================================================================================+
| :func:`_elections_vote_place_address_patterns_ <actuariat_python.data.elections._elections_vote_place_address_patterns_>`       |              |                                                                                                                                                                                                                                               |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_setup_hook <actuariat_python._setup_hook>`                                                                              |              | does nothing                                                                                                                                                                                                                                  |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`check <actuariat_python.check>`                                                                                          |              | Checks the library is working. It raises an exception.                                                                                                                                                                                        |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`clean_function_notebook <actuariat_python.automation.notebook_test_helper.clean_function_notebook>`                      |              | Default cleaning for notebooks cells when unittesting.                                                                                                                                                                                        |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`elections_legislatives_bureau_vote <actuariat_python.data.elections.elections_legislatives_bureau_vote>`                 |              | Retrieves data from `Résultat des élections législatives françaises de 2012 au niveau bureau de vote <https://www.data.gouv.fr/fr/datasets/resultat-des-elections-legislatives-francaises-de-2012-au-niveau-bureau-de-vote-nd/>`_. ...        |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`elections_legislatives_circonscription_geo <actuariat_python.data.elections.elections_legislatives_circonscription_geo>` |              | Retrieves data from `Countours des circonscriptions des législatives <https://www.data.gouv.fr/fr/ datasets/countours-des-circonscriptions-des-legislatives-nd/>`_. ...                                                                       |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`elections_presidentielles <actuariat_python.data.elections.elections_presidentielles>`                                   |              | Downloads the data for the French elections from *data.gouv.fr*.                                                                                                                                                                              |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`elections_presidentielles_local_files <actuariat_python.data.elections.elections_presidentielles_local_files>`           |              | Returns the list of files included in this module about French elections.                                                                                                                                                                     |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`elections_vote_place_address <actuariat_python.data.elections.elections_vote_place_address>`                             |              | Scrapes and extracts addresses for every vote place (bureau de vote in French).                                                                                                                                                               |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`elections_vote_places_geo <actuariat_python.data.elections.elections_vote_places_geo>`                                   |              | Retrieves data vote places (bureaux de vote in French) with geocodes.                                                                                                                                                                         |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_appointments <actuariat_python.exams.ex2016.enumerate_appointments>`                                           |              | enumerate a list of appointments for a given list of ids                                                                                                                                                                                      |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_person <actuariat_python.exams.ex2016.enumerate_person>`                                                       |              | enumerate a person randomly chosen                                                                                                                                                                                                            |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_wolf_synonyms <actuariat_python.data.wolf.enumerate_wolf_synonyms>`                                            |              | enumerate list of synonyms Language is French.                                                                                                                                                                                                |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_wolf_xml_row <actuariat_python.data.wolf.enumerate_wolf_xml_row>`                                              |              | walk through an XML file returned by function :func:`wolf_xml`                                                                                                                                                                                |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`execute_notebooks <actuariat_python.automation.notebook_test_helper.execute_notebooks>`                                  |              | Executes a list of notebooks.                                                                                                                                                                                                                 |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`fecondite_france <actuariat_python.data.population.fecondite_france>`                                                    |              | download fecondity table for France (Excel format)                                                                                                                                                                                            |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`geocode <actuariat_python.data.geocoding.geocode>`                                                                       |              | geocode addresses                                                                                                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_additional_paths <actuariat_python.automation.notebook_test_helper.get_additional_paths>`                            |              | returns a list of paths to add before running the notebooks, paths to pyquickhelper, pyensae, pymmails                                                                                                                                        |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`html_to_text <actuariat_python.data.elections.html_to_text>`                                                             |              | Given a piece of HTML, return the plain text it contains. This handles entities and char refs, but not javascript and ...                                                                                                                     |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`instruction_pass <actuariat_python.faq.faq_python.instruction_pass>`                                                     |              | Cette fonction ne fait rien.                                                                                                                                                                                                                  |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`ls_notebooks <actuariat_python.automation.notebook_test_helper.ls_notebooks>`                                            |              | list the notebooks in a particular subfolder                                                                                                                                                                                                  |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`plot_population_pyramid <actuariat_python.plots.pyramid.plot_population_pyramid>`                                        |              | create a population pyramid                                                                                                                                                                                                                   |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`population_france_year <actuariat_python.data.population.population_france_year>`                                        |              | Downloads the data for the French population from INSEE website                                                                                                                                                                               |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`read_csv_from_excel <actuariat_python.faq.faq_pandas.read_csv_from_excel>`                                               |              | Read a file stored in CSV format from Excel.                                                                                                                                                                                                  |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`table_mortalite_euro_stat <actuariat_python.data.population.table_mortalite_euro_stat>`                                  |              | This function retrieves mortality table from `EuroStat <http://ec.europa.eu/eurostat/fr>`_ through `table de mortalité <http://www.data-publica.com/opendata/7098--population-et-conditions-sociales-table-de-mortalite-de-1960-a-2010>`_ ... |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`table_mortalite_france_00_02 <actuariat_python.data.population.table_mortalite_france_00_02>`                            |              | Download mortality table for France assuming they are available in Excel format.                                                                                                                                                              |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`villes_geo <actuariat_python.data.elections.villes_geo>`                                                                 |              | Retrieves data vote places (bureaux de vote in French) with geocodes.                                                                                                                                                                         |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`wolf_xml <actuariat_python.data.wolf.wolf_xml>`                                                                          |              | The `WOLF <http://alpage.inria.fr/~sagot/wolf-en.html>`_ (Wordnet Libre du Français, Free French Wordnet) is a free ...                                                                                                                       |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+