improves metadata

src/dynaword/tables.py

@@ -45,9 +45,15 @@ def create_dataset_readme_references():
     return readme_references
 
 
-def create_overview_table(repo_path: Path = repo_path) -> pd.DataFrame:
+def create_overview_table(
+    repo_path: Path = repo_path,
+    add_readable_tokens: bool = True,
+    add_total_row: bool = True,
+    add_readme_references: bool = True,
+) -> pd.DataFrame:
     table = {
         "Source": [],
+        "Source with link": [],
         "Description": [],
         "Domain": [],
         "N. Tokens": [],
@@ -62,22 +68,42 @@ def create_overview_table(repo_path: Path = repo_path) -> pd.DataFrame:
         desc_stats = sheet.get_descritive_stats()
         main_domain = sheet.domains[0] if sheet.domains else ""
 
-        table["Source"] += [f"[{dataset_path.name}]"]
+        table["Source"] += [f"{dataset_path.name}"]
+        table["Source with link"] += [f"[{dataset_path.name}]"]
         table["License"] += [f"[{sheet.license_name}]"]
         table["Domain"] += [main_domain]
         table["Description"] += [sheet.short_description]
         table["N. Tokens"] += [desc_stats.number_of_tokens]
 
-    # total
-    table["Source"] += ["**Total**"]
-    table["Domain"] += [""]
-    table["License"] += [""]
-    table["Description"] += [""]
-    table["N. Tokens"] += [sum(table["N. Tokens"])]
-
     df = pd.DataFrame.from_dict(table)
     df = df.sort_values("N. Tokens", ascending=False)
-    df["N. Tokens"] = df["N. Tokens"].apply(human_readable_large_int)
+
+    if add_total_row:
+        total_row = {
+            "Source": "**Total**",
+            "Source with link": "**Total**",
+            "Domain": "",
+            "License": "",
+            "Description": "",
+            "N. Tokens": sum(table["N. Tokens"]),
+        }
+        df = pd.concat(
+            [
+                df,
+                pd.DataFrame([total_row]),
+            ],
+            ignore_index=True,
+        )
+    if add_readme_references:
+        # replace Source with Source with link
+        df["Source"] = df["Source with link"]
+        df = df.drop(columns=["Source with link"])
+    else:
+        # remove Source with link
+        df = df.drop(columns=["Source with link"])
+
+    if add_readable_tokens:
+        df["N. Tokens"] = df["N. Tokens"].apply(human_readable_large_int)
 
     return df