Skip to content

Commit

Permalink
bonsai.md documentation update
Browse files Browse the repository at this point in the history 
Added list of summary statistics to the bottom of bonsai.md
  • Loading branch information
@joannakennedyharvard
joannakennedyharvard authored Sep 26, 2023
1 parent 7a916d8 commit aeef575
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/source/bonsai.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,28 @@ This file contains the classes and functions needed to simulate GPS data.
* `generate_nodes`: (function) Generates multiple amenities coordinates.
* `sim_gps_data`: (function) Generates gps trajectories.
* `gps_to_csv`: (function) Writes gps trajectories to csv files.

## List of summary statistics

The summary statistics that are generated are listed below:

| Variable | Type | Description of Variable |
|-----------------------------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| num_in_call | int | The total number of incoming calls. |
| num_out_call | int | The total number of outgoing calls. |
| num_mis_call | int | The total number of missed calls. |
| num_in_caller | int | The total number of unique individuals who called the subject. |
| num_out_caller | int | The total number of unique individuals called by the subject. |
| num_mis_caller | int | The total number of unique individuals who called the subject but without answering. |
| total_mins_in_calls | float | The duration (minute) of all incoming calls. |
| total_mins_out_call | float | The duration (minute) of all outgoing calls.|
| num_s | int | The total number of sent SMS.|
| num_r | int | The total number of received SMS.|
| num_mms_s | int | The total number of sent MMS.|
| num_mms_r | int | The total number of received MMS. |
| num_s_tel | int | The total number of unique phone numbers that sent messages to the subject. |
| num_r_tel | int | The total number of unique phone numbers that received messages from the subject. |
| total_char_s | int | The total number of characters in all sent messages. |
| total_char_r | int | The total number of characters in all received messages. |
| text_reciprocity_incoming | int | The total number of unique phone numbers that sent messages to the subject but didn’t get replied. |
| text_reciprocity_outgoing | int | The total number of unique phone numbers that received messages from the subject but didn’t reply. |

0 comments on commit aeef575

Please sign in to comment.