From 7870537bdc08820074b2566b4e57a0fd758abe9f Mon Sep 17 00:00:00 2001 From: cynddl Date: Wed, 1 Jul 2015 16:29:15 -0400 Subject: [PATCH] Update network legend and header in IO documentation page --- demo/viz/network_view/index.html | 2 +- docs/index.rst | 4 ++-- docs/quickstart.rst | 2 +- docs/reference/bandicoot.io.rst | 15 +++++++-------- 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/demo/viz/network_view/index.html b/demo/viz/network_view/index.html index c1c78cc..0543b37 100644 --- a/demo/viz/network_view/index.html +++ b/demo/viz/network_view/index.html @@ -41,7 +41,7 @@ - + diff --git a/docs/index.rst b/docs/index.rst index 7118786..ecb343b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ -bandicoot -- a python toolbox to learn from metadata -==================================================== +bandicoot, an open-source python toolbox to analyze mobile phone metadata +========================================================================= `bandicoot `_ is an open-source python toolbox to analyze and extract behavioral indicators from mobile phone data. It is developed by `Yves-Alexandre de Montjoye `_, `Luc diff --git a/docs/quickstart.rst b/docs/quickstart.rst index b8a7e7e..236e686 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -19,7 +19,7 @@ bandicoot takes one file per user and assume that all user records are in the pr >>> B = bc.read_csv('my_user', 'records/', 'antennas.csv') -This :meth:`~bandicoot.io.read_csv` will load records for the user `my_user` from `records/my_user.csv` and will load antennas from the file `antennas.csv`. Optionally, bandicoot can also load a file containing :ref:`attributes ` for this user. +This :meth:`~bandicoot.io.read_csv` will load records for the user `my_user` from `records/my_user.csv` and will load antennas from the file `antennas.csv`. Optionally, bandicoot can also load a file containing :ref:`attributes ` for this user. .. image:: _static/mini-mockups-01.png diff --git a/docs/reference/bandicoot.io.rst b/docs/reference/bandicoot.io.rst index 568cc0f..eee01b5 100644 --- a/docs/reference/bandicoot.io.rst +++ b/docs/reference/bandicoot.io.rst @@ -1,6 +1,12 @@ IO == + +:meth:`~bandicoot.io.read_csv` is the standard way to load users. bandicoot can also load users though +:meth:`~bandicoot.io.load` (low-level function, called by :meth:`~bandicoot.io.read_csv`) or other CSV formats such as +:meth:`~bandicoot.io.read_orange` or :meth:`~bandicoot.io.read_telenor` (deprecated). + + .. currentmodule:: bandicoot.io .. autosummary:: @@ -15,14 +21,7 @@ IO filter_record -.. _loadingdata-label: - -Loading data and exporting indicators -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -:meth:`~bandicoot.io.read_csv` is the standard way to load users. bandicoot can also load users though -:meth:`~bandicoot.io.load` (low-level function, called by :meth:`~bandicoot.io.read_csv`) or other CSV formats such as -:meth:`~bandicoot.io.read_orange` or :meth:`~bandicoot.io.read_telenor` (deprecated). +.. _attributes-label: Attributes ----------