Skip to content

Commit

Permalink
update XGI-DATA table
Browse files Browse the repository at this point in the history
  • Loading branch information
nwlandry committed Apr 4, 2024
1 parent b079699 commit 60e0699
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 15 deletions.
5 changes: 2 additions & 3 deletions docs/source/_static/table.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,15 @@ async function fetch_JSON_file(url) {
}
}

function create_table(json_data) {
const body = document.body;
function create_table(json_data) {
const section = document.getElementById("network-statistics")
const table = document.createElement('table');
const table_header = document.createElement('thead')
const table_body = document.createElement('tbody')

// Create header row
const header_row = document.createElement('tr');
const headers = ["Dataset", "|V|", "|E|", "|E<sub>unique</sub>|", "s<sub>max</sub>"]
const headers = ["Dataset", "|V|", "|E|", "|E<sup>*</sup>|", "s<sub>max</sub>"]
const header_attrs = ["num-nodes", "num-edges", "num-unique-edges", "max-edge-size"]

for (const i in headers) {
Expand Down
22 changes: 10 additions & 12 deletions docs/source/xgi-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ Dataset format

The xgi-data format for higher-order datasets is a JSON data structure with the following structure:

* "hypergraph-data": This tag accesses the attributes of the entire hypergraph dataset such as the authors or dataset name.
* :code:`hypergraph-data`: This tag accesses the attributes of the entire hypergraph dataset such as the authors or dataset name.

* "node-data": This tag accesses the nodes of the hypergraph and their associated properties as a dictionary where the keys are node IDs and the corresponding values are dictionaries. If a node doesn't have any properties, the associated dictionary is empty.
* :code:`node-data`: This tag accesses the nodes of the hypergraph and their associated properties as a dictionary where the keys are node IDs and the corresponding values are dictionaries. If a node doesn't have any properties, the associated dictionary is empty.

* "name": This tag accesses the node's name if there is one that is different from the ID specified in the hyperedges.
* :code:`name`: This tag accesses the node's name if there is one that is different from the ID specified in the hyperedges.
* Other tags are user-specified based on the particular attributes provided by the dataset.

* "edge-data": This tag accesses the hyperedges of the hypergraph and their associated attributes.
* :code:`edge-data`: This tag accesses the hyperedges of the hypergraph and their associated attributes.

* "name": This tag accesses the edge's name if one is provided.
* "timestamp": This is the tag specifying the time associated with the hyperedge if it is given. All times are stored in ISO8601 standard.
* :code:`name`: This tag accesses the edge's name if one is provided.
* :code:`timestamp`: This is the tag specifying the time associated with the hyperedge if it is given. All times are stored in ISO8601 standard.
* Other tags are user-specified based on the particular attributes provided by the dataset.

* "edge-dict": This tag accesses the edge IDs and the corresponding nodes which participate in that hyperedge.
* :code:`edge-dict`: This tag accesses the edge IDs and the corresponding nodes which participate in that hyperedge.

Loading datasets
----------------
Expand All @@ -42,12 +42,10 @@ Network Statistics

.. raw:: html

<style>
</style>

<script type="text/javascript">
display_table()
</script>

<p>More details on individual datasets are available at the <a href="https://github.com/xgi-org/xgi-data">XGI-DATA page</a>.</p>
<p>More details on individual datasets are available at the <a href="https://github.com/xgi-org/xgi-data">XGI-DATA page</a>.</p>

<p>In this table, |V| denotes the number of nodes, |E| denotes the number of edges, |E<sup>*</sup>| denotes the number of unique edges, and s<sub>max</sub> denotes the maximum edge size.</p>

0 comments on commit 60e0699

Please sign in to comment.