Skip to content

Commit

Permalink
Update README regarding mandatory edge attributes
Browse files Browse the repository at this point in the history
Add note to mandatory edge and vertex attributes that they will be only
added when instances of 'NetworkBuilder' are used to obtain networks.
Otherwise, we can give no guarantee.

Add 'weight' as mandatory edge attributes.

Signed-off-by: Claus Hunsen <hunsen@fim.uni-passau.de>
  • Loading branch information
clhunsen committed Mar 4, 2019
1 parent d9f527c commit 641624b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Analogously, these edge-construction algorithms apply also for all other relatio

#### Vertex and edge attributes

There are some mandatory attributes that are added to vertices and edges in the process of network construction. These are not optional.
There are some mandatory attributes that are added to vertices and edges in the process of network construction. These are not optional and will be added in all cases when using instances of the class `NetworkBuilder` to obtain networks.

- Mandatory *vertex* attributes
* `type`
Expand All @@ -296,6 +296,8 @@ There are some mandatory attributes that are added to vertices and edges in the
* `artifact.type`
- The specific artifact type associated with the event causing the respective edge
- [`"File"`, `"Feature"`, `"Function"`, `"Mail"`, `"IssueEvent"`,`"FeatureExpression"`]
* `weight`
- The weight of the respective edge
* `date`
- The date of the event causing the respective edge

Expand Down

0 comments on commit 641624b

Please sign in to comment.