Skip to content

Commit

Permalink
README: improve formatting of the flags documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hoijui committed May 8, 2020
1 parent 116c036 commit cfe61f6
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,31 +31,31 @@ There are two options:
java -Djava.awt.headless=true -Xmx8g -jar target/forceatlas2-*-jar-with-dependencies.jar [FLAG]...
```

where flags are
where possible values for `[FLAG]...` are:

Flag | Description | Default Value
--- | --- | ---
--input | Input graph in one of Gephi input file formats https://gephi.org/users/supported-graph-formats/ |
--output | Output file |
--nsteps | Number of iterations. Mutually exclusive with --targetChangePerNode |
--targetChangePerNode | Target distance change per node before stop the algorithm. Mutually exclusive with --nsteps |
--targetSteps | Maximum number of iterations before stopping the algoritm. This option is together with --targetChangePerNode | 10000
--2d | Whether to produce a 2d layout | false
--directed | Whether input graph is directed | false
--nthreads | Number of threads to use. | All cores
--format | Output file format. One of csv, gdf, gexf, gml, graphml, pajek, txt | txt
--coords | Tab separated file containing initial coordinates with headers id, x, y, and, z |
--seed | Seed for random number generation for initial node position | timestamp
--barnesHutSplits | Rounds of splits to use for Barnes-Hut tree building. Number of regions after splitting is 4^barnesHutSplits for 2D and 8^barnesHutSplits for 3D |
--barnesHutTheta | Theta of the Barnes Hut optimization | 1.2
--barnesHutUpdateIter | Update Barnes-Hut tree every barnesHutUpdateIter iterations | 1
--updateCenter | Update Barnes-Hut region centers when not rebuilding Barnes-Hut tree | false
--jitterTolerance | How much swinging you allow. Above 1 discouraged. Lower gives less speed and more precision. | 1.0
--linLogMode | Switch ForceAtlas' model from lin-lin to lin-log (tribute to Andreas Noack). Makes clusters more tight. | false
--scalingRatio | How much repulsion you want. More makes a more sparse graph | 2.0 if # nodes >= 100, otherwise 10.0
--gravity | Attracts nodes to the center | 1.0
--strongGravityMode | A stronger gravity law | false
--outboundAttractionDistribution | Distributes attraction along outbound edges. Hubs attract less and thus are pushed to the borders. | false
`--input` | Input graph in one of [Gephi input file formats](https://gephi.org/users/supported-graph-formats/) |
`--output` | Output file; see also `--format` |
`--nsteps` | Number of iterations. Mutually exclusive with `--targetChangePerNode` |
`--targetChangePerNode` | Target distance change per node before stop the algorithm. Mutually exclusive with `--nsteps` |
`--targetSteps` | Maximum number of iterations before stopping the algoritm. This option is together with `--targetChangePerNode` | 10000
`--2d` | Whether to produce a 2d layout | false
`--directed` | Whether input graph is directed | false
`--nthreads` | Number of threads to use. | All cores
`--format` | Output file format. One of `csv`, `gdf`, `gexf`, `gml`, `graphml`, `pajek`, `txt` | txt
`--coords` | Tab separated file, containing initial coordinates with headers `id, x, y, z` |
`--seed` | Seed for random number generation for initial node position | timestamp
`--barnesHutSplits` | Rounds of splits to use for Barnes-Hut tree building. Number of regions after splitting is `(2^2)^barnesHutSplits` for 2D, and `(2^3)^barnesHutSplits` for 3D |
`--barnesHutTheta` | Theta of the Barnes Hut optimization | 1.2
`--barnesHutUpdateIter` | Update Barnes-Hut tree every `barnesHutUpdateIter` iterations | 1
`--updateCenter` | Update Barnes-Hut region centers when not rebuilding Barnes-Hut tree | false
`--jitterTolerance` | How much swinging you allow. Above 1 discouraged. Lower gives less speed and more precision. | 1.0
`--linLogMode` | Switch ForceAtlas' model from lin-lin to lin-log (tribute to Andreas Noack). Makes clusters more tight. | false
`--scalingRatio` | How much repulsion you want. More makes a more sparse graph | 2.0 if # nodes >= 100, otherwise 10.0
`--gravity` | Attracts nodes to the center | 1.0
`--strongGravityMode` | A stronger gravity law | false
`--outboundAttractionDistribution` | Distributes attraction along outbound edges. Hubs attract less and thus are pushed to the borders. | false


## Example Datasets
Expand Down

0 comments on commit cfe61f6

Please sign in to comment.