Feature/dataset deprecation (and comments on datasets.js)

src/datasets.js

@@ -1,8 +1,10 @@
 const fs = require('fs');
 
-function link(title, href) {
+// If href is provided, format the string as a markdown link
+function createMarkdownLink(title, href) {
     let s = title;
 
+
     if (href) {
         s = `[${s}](${href})`;
     }
@@ -14,15 +16,20 @@ function sanitize(text) {
     if (!text) {
         return text;
     }
-    if(typeof text === 'number') {
+
+    if (typeof text === 'number') {
         return String(text);
     }
-    return text.replace(/>/, "\\>")
+    // Replace '>' with escaped version
+    return text.replace(/>/, "\\>");
 }
 
 function getIcon(feature) {
+    // Split the feature (e.g. "pose:OpenPose") into type and specificity ("pose" and "OpenPose")
+    // allows various specific features with the same type (pose:OpenPose and pose:MediaPipe) to get the same icon.
     const [type, specificity] = feature.split(":");
-    const dict = {
+
+    const featureEmojiDict = {
         'video': '🎥',
         'pose': '👋',
         'mouthing': '👄',
@@ -31,47 +38,58 @@ function getIcon(feature) {
         'text': '📜',
         'speech': '🔊',
     };
-    return `<span title="${feature}">${dict[type]}</span>` || "TODO";
+
+    return `<span title="${feature}">${featureEmojiDict[type]}</span>` || "TODO";
     // return `![${type}](assets/icons/${type}.png "${feature}")`;
 }
 
 function printRow(row) {
     console.log('|', row.join(' | '), '|');
 }
 
-
 const PATH = "src/datasets/";
 
-const datasets = fs.readdirSync(PATH)
-    .map(fName => String(fs.readFileSync(PATH + fName)))
-    .map(d => JSON.parse(d))
-    .sort((a, b) => a.pub.name.toLowerCase() > b.pub.name.toLowerCase() ? 1 : -1);
-
+const datasets = fs.readdirSync(PATH) // Read all filenames in the directory * 
+    .map(fName => String(fs.readFileSync(PATH + fName))) // Read each file's content and convert to string *
+    .map(d => JSON.parse(d)) // Parse the JSON content. * 
+    .sort((a, b) => a.pub.name.toLowerCase() > b.pub.name.toLowerCase() ? 1 : -1); // Sort datasets by publication name *
 
 const columns = ['Dataset', 'Publication', 'Language', 'Features', '#Signs', '#Samples', '#Signers', 'License'];
-const lengths = [4, 7, 3, 2, 2, 5, 2, 5]
-// console.log('<table cellspacing="0" border="1" style="max-width: 100%;">')
-printRow(columns); // Header row
-console.log('|' + lengths.map((l) => new Array(l).fill('-').join('')).join(' | ') + '|'); // Divider row
+const lengths = [4, 7, 3, 2, 2, 5, 2, 5];
+
+printRow(columns);
+
+// divider row
+console.log('|' + lengths.map((l) => new Array(l).fill('-').join('')).join(' | ') + '|');
 
 const downloadEmoji = '💾';
 
 for (const dataset of datasets) {
-    let title = link(dataset.pub.name, dataset.pub.url);
+
+    if (dataset.status === "deprecated") {
+        continue;
+    }
+
+    let title = createMarkdownLink(dataset.pub.name, dataset.pub.url);
+
     if (dataset.loader) {
         const sld = 'https://github.com/sign-language-processing/datasets/tree/master/sign_language_datasets/datasets/' + dataset.loader;
-        title += ' ' + link(downloadEmoji, sld);
+        title += ' ' + createMarkdownLink(downloadEmoji, sld);
     }
 
+
+    // note - falsy (empty, null, etc) values just replaced with blank strings
     const row = [
         title,
-        dataset.pub.publication ? `@${dataset.pub.publication}` : dataset.pub.year || "",
+        dataset.pub.publication ? `@${dataset.pub.publication}` : dataset.pub.year || "", // add citation syntax @citationkey. Make/Pandoc later replace with citation
         dataset.language,
         dataset["features"].length ? dataset["features"].map(getIcon).join("") : "TODO",
         dataset["#items"] ? dataset["#items"].toLocaleString('en-US') : "",
         sanitize(dataset["#samples"]) || "",
         dataset["#signers"] || "",
-        link(dataset.license, dataset.licenseUrl)
+        createMarkdownLink(dataset.license, dataset.licenseUrl)
     ];
+
+
     printRow(row);
 }

src/datasets/ATIS.json

@@ -10,6 +10,7 @@
   "#items": 292,
   "#samples": "595 Sentences ",
   "#signers": null,
+  "status": "deprecated",
   "license": null,
   "licenseUrl": null
 }