Skip to content

Commit

Permalink
Add ability to have explanatory footers for each graph.
Browse files Browse the repository at this point in the history
  • Loading branch information
@qqmyers
qqmyers committed Jan 6, 2021
1 parent 9283fd6 commit b6cea2d
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 20 deletions.
15 changes: 15 additions & 0 deletions config.local.json.sample
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@
"downloadsHeader": "Downloads",
"makeDataCountHeader": "Make Data Count",
"holdingsHeader": "Holdings",
"timeseries.dataverses.definition":"Total Number of published Dataverses as a function of time.",
"timeseries.datasets.definition":"Total Number of published Datasets as a function of time.",
"timeseries.files.definition":"Total Number of Files in published Datasets as a function of time.",
"timeseries.downloads.definition":"Total Number of Files Downloaded as a function of time.",
"dataversesbycategory.definition":"The distribution of Dataverses by category.",
"dataversesbysubject.definition":"The distribution of Dataverses by subject.",
"datasetsbysubject.definition":"The distribution of Datasets by subject.",
"uniquedownloads.definition":"Unique downloads per Dataset. This metric represents the number of people who have downloaded one or more files from a given dataset.",
"multitimeseries.uniquedownloads.definition":"Unique downloads per Dataset as a function of time. This metric represents the number of people who have downloaded one or more files from a given dataset.",
"filesbytype.definition":"The distribution of Files by type.",
"filedownloads.definition":"Downloads per File.",
"makedatacount.viewstotal.definition":"Total Number of Dataset Views. This correspond with 'Total Dataset Investigations' as define by the Make Data Count standard.",
"makedatacount.downloadstotal.definition":"Total Number of Dataset Downloads. This correspond with 'Total Dataset Requests' as define by the Make Data Count standard.",
"makedatacount.viewsunique.definition":"Number of Unique Dataset Views. This correspond with 'Unique Dataset Investigations' as define by the Make Data Count standard.",
"makedatacount.downloadsunique.definition":"Number of Unique Dataset Downloads. This correspond with 'Unique Dataset Requests' as define by the Make Data Count standard.",
"maxBars": 100,
"globalConfigured":"false",
"colors": {
Expand Down
81 changes: 61 additions & 20 deletions installationplots.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,12 @@ function timeseries(name, config) {
.color(function(d) {
return color;
})
.resize(true)
.draw()
.resize(true);
if(config.hasOwnProperty("timeseries." + lcname + ".definition")) {
var explain = config["timeseries." + lcname + ".definition"];
visualization.footer(config["timeseries." + lcname + ".definition"]);
}
visualization.draw();
}
});
$("#" + lcname).append($("<a/>").addClass("button").attr("href", "/api/info/metrics/" + lcname + "/monthly" + addAlias()).attr("type", "text/csv").text("CSV"));
Expand Down Expand Up @@ -169,8 +173,12 @@ function dataversesByCategory(config) {
}
})
.legend(false)
.resize(true)
.draw();
.resize(true);
if(config.hasOwnProperty("dataversesbycategory.definition")) {
var explain = config["dataversesbycategory.definition"];
visualization.footer(config["dataversesbycategory.definition"]);
}
visualization.draw();
}
});
$("#dataverses-by-category").append($("<a/>").addClass("button").attr("href", "/api/info/metrics/dataverses/byCategory" + addAlias()).attr("type", "text/csv").text("CSV"));
Expand Down Expand Up @@ -209,8 +217,12 @@ function dataversesBySubject(config) {
}
})
.legend(false)
.resize(true)
.draw();
.resize(true);
if(config.hasOwnProperty("dataversesbysubject.definition")) {
var explain = config["dataversesbysubject.definition"];
visualization.footer(config["dataversesbysubject.definition"]);
}
visualization.draw();
}
});
$("#dataverses-by-subject").append($("<a/>").addClass("button").attr("href", "/api/info/metrics/dataverses/bySubject" + addAlias()).attr("type", "text/csv").text("CSV"));
Expand Down Expand Up @@ -249,8 +261,12 @@ function datasetsBySubject(config) {
}
})
.legend(false)
.resize(true)
.draw();
.resize(true);
if(config.hasOwnProperty("datasetsbysubject.definition")) {
var explain = config["datasetsbysubject.definition"];
visualization.footer(config["datasetsbysubject.definition"]);
}
visualization.draw();
}
});
$("#datasets-by-subject").append($("<a/>").addClass("button").attr("href", "/api/info/metrics/datasets/bySubject" + addAlias()).attr("type", "text/csv").text("CSV"));
Expand Down Expand Up @@ -285,8 +301,12 @@ function makeDataCount(metric, config) {
.color(function(d) {
return color;
})
.resize(true)
.draw();
.resize(true);
if(config.hasOwnProperty("makedatacount." + metric + ".definition")) {
var explain = config["makedatacount." + metric + ".definition"];
visualization.footer(config["makedatacount." + metric + ".definition"]);
}
visualization.draw();
}
});
$("#makedatacount-" + metric).append($("<a/>").addClass("button").attr("href", "/api/info/metrics/makeDataCount/" + metric + "/monthly" + addAlias()).attr("type", "text/csv").text("CSV"));
Expand Down Expand Up @@ -324,8 +344,12 @@ function multitimeseries(name, config, groupby) {
window.open(dvserver + "/dataset.xhtml?persistentId=" + JSON.stringify(d.d3plus_data[groupby]).replace(/["]+/g,''), target="_blank");
}
})
.resize(true)
.draw();
.resize(true);
if(config.hasOwnProperty("multitimeseries." + lcname + ".definition")) {
var explain = config["multitimeseries." + lcname + ".definition"];
visualization.footer(config["multitimeseries." + lcname + ".definition"]);
}
visualization.draw();
}
});
$("#" + lcname).append($("<a/>").addClass("button").attr("href", "/api/info/metrics/" + lcname + "/monthly" + addAlias()).attr("type", "text/csv").text("CSV"));
Expand Down Expand Up @@ -357,8 +381,13 @@ function filesByType(config) {
})
.order("count")
.text("contenttype")
.resize(true)
.draw();
.resize(true);
if(config.hasOwnProperty("filesbytype.definition")) {
var explain = config["filesbytype.definition"];
countVisualization.footer(config["filesbytype.definition"]);
}
countVisualization.draw();

var sizeVisualization = d3plus.viz()
.data(data).dev(true)
.title("File Size By Type")
Expand All @@ -376,8 +405,12 @@ function filesByType(config) {
})
.order("size")
.text("contenttype")
.resize(true)
.draw();
.resize(true);
if(config.hasOwnProperty("filesbytype.definition")) {
var explain = config["filesbytype.definition"];
sizeVisualization.footer(config["filesbytype.definition"]);
}
sizeVisualization.draw();
}
});
$("#files-by-type-count").append($("<a/>").addClass("button").attr("href", "/api/info/metrics/files/byType" + addAlias()).attr("type", "text/csv").text("CSV"));
Expand Down Expand Up @@ -423,8 +456,12 @@ function uniqueDownloads(config) {
window.open(dvserver + "/dataset.xhtml?persistentId=" + JSON.stringify(d.pid).replace(/["]+/g,''), target="_blank");
}
})
.resize(true)
.draw();
.resize(true);
if(config.hasOwnProperty("uniquedownloads.definition")) {
var explain = config["uniquedownloads.definition"];
visualization.footer(config["uniquedownloads.definition"]);
}
visualization.draw();
}
});
$("#uniquedownloads-by-pid").append($("<a/>").addClass("button").attr("href", "/api/info/metrics/uniquedownloads" + addAlias()).attr("type", "text/csv").text("CSV"));
Expand Down Expand Up @@ -476,8 +513,12 @@ function fileDownloads(config) {
}
}
})
.resize(true)
.draw();
.resize(true);
if(config.hasOwnProperty("filedownloads.definition")) {
var explain = config["filedownloads.definition"];
visualization.footer(config["filedownloads.definition"]);
}
visualization.draw();
}
});
$("#filedownloads-by-id").append($("<a/>").addClass("button").attr("href", "/api/info/metrics/filedownloads" + addAlias()).attr("type", "text/csv").text("CSV"));
Expand Down

0 comments on commit b6cea2d

Please sign in to comment.