Tutorial¶

This guide should help you to get started with the face2face toolbox. You can try out the tutorial here using Binder.

Import Interaction data and Metadata as Data Object¶

Import predefined datasets as Data Object. The Data Class gives you multiple import options. You can import already predefined data sets included in this toolbox, you can import your own data sets or you can import dataframes which you have created. To learn more about the input parameter of this Class check out the Online documentation or the tutorial “import_data_set”. For this example we import the predefined “Synthetic” data set as described below.

>>> import face2face as f2f
>>> df = f2f.Data("Synthetic")

A Data object is a collection of one or two pandas dataframes. It always contains a tij-dataframe, but additionally it can also contain a metadata dataframe. You can use the whole Data-Object as Parameter for all functions where you use tij-dataframes or metadata-dataframes. If you want to access one of the two dataframes of the Data-Object, you can access it like this.

>>> df_tij = Data.interaction
>>> df_meta = Data.metadata

Create different Networks¶

With the Data you can create different kind of networks.

>>> full_network = f2f.create_network_from_data(Data)
>>> hopping_network = f2f.hopping_time_networks(Data, minute= )
>>> sliding_network = f2f.sliding_time_networks(Data, slide= ,interval= )
>>> event_time_network = f2f.event_time_networks(Data, events)

Notebook Tutorials in Git¶

To get an overview of the functions that are included in this toolbox you can work through the following tutorials to get an idea how to use these functions.

If you are already experienced in using python and especially librarys like pandas, numpy and networkX you can skip the beginner tutorials “01_tutorial_exploring_the_data”, “02_tutorial_first_functions” and “03_tutorial_first_functions”.

If you are new to Python or this librarys or you want to refresh your knowledge you can start with the beginner tutorials.

Beginner Tutorials¶

01_tutorial_exploring_the_data¶

This tutorial includes small tasks with functions of pandas that are also used for the functions in this toolbox. The tasks should give you an idea on the functions that are used for this toolbox like “groupby”, “merge” etc.