hub algorithm closeness

Runs the closeness algorithm on a model and saves the results for each entity to a model property.

Centrality algorithms measure the importance and significance of individual entities and relationships. When you run centrality algorithms, the value returned by an algorithm indicates importance of an element. The closeness centrality of an entity measures its average farness (inverse distance) to all other entities. Entities with a high closeness score have the shortest distances to all other nodes.

Usage

hub algorithm closeness --m model --d direction --m method --wp weightProperty --lvsignificantLowValues --op outputProperty --w waitForComplete

Required	Argument	Description
Yes	--m `model`	Specifies the model.
No	--d `direction`	Specifies the direction to apply to the algorithm where `direction` is one of the following: in The results will be based on incoming relationships on the entity. out The results will be based on outgoing relationships on the entity. both The results will be based on both incoming and outgoing relationships on the entity. This is the default value.
No	--me `method`	Specifies the method in which results are returned: s—Standard. Results are based on the number of attachments, or relationships, an entity has as well as the reverse of the sum of shortest paths to each entity. This is the default value. d—Dangalchev. Results are based not only on the number of entities linked to another entity but also the number of relationships in each of the linked entities. o—Opsahl. Results are based on the sum of reversed shortest paths to each entity.
No	--wp `weightProperty`	Specifies a relationship property to use to measure how unfavorable a relationship is. By default, a higher value indicates a negative association. The default setting is null.
No	--lv `significantLowValues`	If a relationship property is used as weight, this specifies whether a lower value is considered better than a higher value. true Specifies that a lower value is considered better than a higher value for a relationship property used as weight. For example, if the property is some sort of ranking system, 1 or 1st would be considered the best value. If the property is distance, and you are trying to determine the shortest route, 5 miles would be considered better than 10 miles. false Specifies that a higher value is considered better than a lower value for a relationship property used as weight. This is the default value.
No	--op `outputProperty`	Specifies the output property name to be something other than the algorithm name. The default is Closeness.
No	--w `waitForComplete`	Specifies whether to wait for jobs to complete in a synchronous mode. true Specifies to wait for jobs to complete in a synchronous mode. false Specifies to not wait for jobs to complete in a synchronous mode. This is the default value.

Example

The following will run the closeness algorithm on the 911 model.

hub algorithm closeness --m 911