Adding domain table

README.md

@@ -322,6 +322,61 @@ This data generally contains no annotation besides the metadata attached to each
 
 Below follows a brief overview of the sources in the corpus along with their individual license.
 
+<!-- START-DOMAIN TABLE -->
+| Domain       | N. Tokens   | Source with link                                                                        |
+|:-------------|:------------|:----------------------------------------------------------------------------------------|
+| Legal        | 2.23B       | [cellar], [eur-lex-sum-da], [fm-udgivelser], [retsinformationdk], [skat], [retspraksis] |
+| Books        | 722.00M     | [ncc_books], [memo], [adl], [wikibooks], [jvj], [gutenberg], [relig]                    |
+| Conversation | 497.09M     | [danske-taler], [opensubtitles], [ep], [ft], [spont], [naat]                            |
+| Social Media | 389.32M     | [hest]                                                                                  |
+| Other        | 340.59M     | [ncc_parliament], [dannet], [depbank], [synne]                                          |
+| Web          | 295.87M     | [ai-aktindsigt], [ncc_maalfrid], [miljoeportalen]                                       |
+| Encyclopedic | 127.35M     | [wikisource], [wiki]                                                                    |
+| News         | 60.63M      | [ncc_newspaper], [tv2r], [nordjyllandnews]                                              |
+| Medical      | 27.07M      | [health_hovedstaden]                                                                    |
+| Readaloud    | 7.30M       | [nota]                                                                                  |
+| Dialect      | 847.97K     | [botxt]                                                                                 |
+| **Total**    | 4.70B       |                                                                                         |
+
+[ai-aktindsigt]: data/ai-aktindsigt/ai-aktindsigt.md
+[cellar]: data/cellar/cellar.md
+[danske-taler]: data/danske-taler/danske-taler.md
+[ncc_books]: data/ncc_books/ncc_books.md
+[ncc_newspaper]: data/ncc_newspaper/ncc_newspaper.md
+[ncc_maalfrid]: data/ncc_maalfrid/ncc_maalfrid.md
+[ncc_parliament]: data/ncc_parliament/ncc_parliament.md
+[eur-lex-sum-da]: data/eur-lex-sum-da/eur-lex-sum-da.md
+[miljoeportalen]: data/miljoeportalen/miljoeportalen.md
+[fm-udgivelser]: data/fm-udgivelser/fm-udgivelser.md
+[memo]: data/memo/memo.md
+[opensubtitles]: data/opensubtitles/opensubtitles.md
+[retsinformationdk]: data/retsinformationdk/retsinformationdk.md
+[ep]: data/ep/ep.md
+[ft]: data/ft/ft.md
+[wikisource]: data/wikisource/wikisource.md
+[spont]: data/spont/spont.md
+[tv2r]: data/tv2r/tv2r.md
+[adl]: data/adl/adl.md
+[hest]: data/hest/hest.md
+[skat]: data/skat/skat.md
+[dannet]: data/dannet/dannet.md
+[retspraksis]: data/retspraksis/retspraksis.md
+[wikibooks]: data/wikibooks/wikibooks.md
+[jvj]: data/jvj/jvj.md
+[gutenberg]: data/gutenberg/gutenberg.md
+[botxt]: data/botxt/botxt.md
+[depbank]: data/depbank/depbank.md
+[naat]: data/naat/naat.md
+[synne]: data/synne/synne.md
+[wiki]: data/wiki/wiki.md
+[nordjyllandnews]: data/nordjyllandnews/nordjyllandnews.md
+[relig]: data/relig/relig.md
+[nota]: data/nota/nota.md
+[health_hovedstaden]: data/health_hovedstaden/health_hovedstaden.md
+<!-- END-DOMAIN TABLE -->
+
+<details>
+
 <!-- START-MAIN TABLE -->
 | Source               | Description                                                                                                                                                                            | Domain       | N. Tokens   | License                |
 |:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------|:------------|:-----------------------|
@@ -412,6 +467,7 @@ Below follows a brief overview of the sources in the corpus along with their ind
 [Danish Copyright Law]: ./data/domsdatabasen/domsdatabasen.md#license-information
 <!-- END-MAIN TABLE -->
 
+</details>
 
 You can learn more about each dataset by pressing the link in the first column.
 

src/dynaword/tables.py

@@ -108,6 +108,62 @@ def create_overview_table(
     return df
 
 
+def create_domain_table(
+    repo_path: Path = repo_path,
+    add_readable_tokens: bool = True,
+    add_total_row: bool = True,
+) -> pd.DataFrame:
+    table = {
+        "Source with link": [],
+        "Domain": [],
+        "N. Tokens": [],
+    }
+
+    for dataset in _datasets:
+        dataset_path = repo_path / "data" / dataset
+        readme_path = dataset_path / f"{dataset_path.name}.md"
+
+        sheet = DataSheet.load_from_path(readme_path)
+        desc_stats = sheet.get_descritive_stats()
+        main_domain = sheet.domains[0] if sheet.domains else ""
+
+        table["Source with link"] += [f"[{dataset_path.name}]"]
+        table["Domain"] += [main_domain]
+        table["N. Tokens"] += [desc_stats.number_of_tokens]
+
+    if add_total_row:
+        table["Source with link"] += [""]
+        table["Domain"] += ["**Total**"]
+        table["N. Tokens"] += [sum(table["N. Tokens"])]
+
+    df = pd.DataFrame.from_dict(table)
+
+    df = df.groupby("Domain").agg(
+        {"Source with link": lambda x: ", ".join(x), "N. Tokens": sum}
+    )
+
+    df = df.sort_values("N. Tokens", ascending=False)
+
+    df.index.name = "Domain"
+    df = df.reset_index()
+
+    # Trick the Total row to be at the bottom.
+    new_index = list(df.index.drop(0)) + [0]
+    df = df.reindex(new_index)
+
+    if add_readable_tokens:
+        df["N. Tokens"] = df["N. Tokens"].apply(human_readable_large_int)
+
+    return df
+
+
+def create_domain_table_str(repo_path: Path = repo_path) -> str:
+    table = create_domain_table(repo_path)
+    readme_references = create_dataset_readme_references()
+    package = f"{table.to_markdown(index=False)}\n\n{readme_references}\n\n"
+    return package
+
+
 def create_overview_table_str(repo_path: Path = repo_path) -> str:
     main_table = create_overview_table(repo_path)
     readme_references = create_dataset_readme_references()

src/dynaword/update_descriptive_statistics.py

@@ -24,7 +24,11 @@ from dynaword.git_utilities import (
 )
 from dynaword.paths import repo_path
 from dynaword.plot_tokens_over_time import create_tokens_over_time_plot
-from dynaword.tables import create_overview_table, create_overview_table_str
+from dynaword.tables import (
+    create_domain_table_str,
+    create_overview_table,
+    create_overview_table_str,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -104,8 +108,11 @@ def update_dataset(
 
     if dataset_name == "default":
         logger.info("Updating Overview table")
-        package = create_overview_table_str()
-        sheet.body = sheet.replace_tag(package=package, tag="MAIN TABLE")
+        overview_table = create_overview_table_str()
+        sheet.body = sheet.replace_tag(package=overview_table, tag="MAIN TABLE")
+        logger.info("Updating domain table")
+        domain_table = create_domain_table_str()
+        sheet.body = sheet.replace_tag(package=domain_table, tag="DOMAIN TABLE")
         create_domain_distribution_plot()
         create_tokens_over_time_plot()