[dashboard | statistics] Add Project Size to dashboard charts

SQL/0000-00-00-schema.sql

@@ -1496,6 +1496,35 @@ INSERT INTO StatisticsTabs (ModuleName, SubModuleName, Description, OrderNo) VAL
   ('statistics', 'stats_behavioural', 'Behavioural Statistics', 3),
   ('statistics', 'stats_MRI', 'Imaging Statistics', 4);
 
+
+-- ********************************
+-- statistics
+-- ********************************
+
+
+CREATE TABLE `cached_data_type` (
+    `CachedDataTypeID` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+    `Name` VARCHAR(255) UNIQUE NOT NULL,
+    PRIMARY KEY  (`CachedDataTypeID`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+
+INSERT INTO `cached_data_type` (`Name`) SELECT 'projects_disk_space';
+
+
+CREATE TABLE `cached_data` (
+   `CachedDataID` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+   `CachedDataTypeID` INT(10) UNSIGNED NOT NULL,
+   `Value` TEXT NOT NULL,
+   `LastUpdate` TIMESTAMP NOT NULL
+       DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+   PRIMARY KEY  (`CachedDataID`),
+   CONSTRAINT `FK_cached_data_type` FOREIGN KEY (`CachedDataTypeID`)
+       REFERENCES `cached_data_type` (`CachedDataTypeID`)
+       ON UPDATE CASCADE ON DELETE CASCADE
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+
 -- ********************************
 -- server_processes tables
 -- ********************************
@@ -2688,4 +2717,4 @@ CREATE TABLE `redcap_notification` (
   `handled_dt` datetime NULL,
   PRIMARY KEY (`id`),
   KEY `i_redcap_notif_received_dt` (`received_dt`)
-) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;

SQL/New_patches/2025_09_11_add_data_cache_table.sql

@@ -0,0 +1,21 @@
+-- Create cached_data_type table to track different types of cached data
+CREATE TABLE `cached_data_type` (
+    `CachedDataTypeID` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+    `Name` VARCHAR(255) UNIQUE NOT NULL,
+    PRIMARY KEY  (`CachedDataTypeID`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+-- Create cached_data table to track cached data
+CREATE TABLE `cached_data` (
+   `CachedDataID` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+   `CachedDataTypeID` INT(10) UNSIGNED NOT NULL,
+   `Value` TEXT NOT NULL,
+   `LastUpdate` TIMESTAMP NOT NULL
+       DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+   PRIMARY KEY  (`CachedDataID`),
+   CONSTRAINT `FK_cached_data_type` FOREIGN KEY (`CachedDataTypeID`)
+       REFERENCES `cached_data_type` (`CachedDataTypeID`)
+       ON UPDATE CASCADE ON DELETE CASCADE
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+INSERT INTO `cached_data_type` (`Name`) SELECT 'projects_disk_space';

modules/statistics/jsx/widgets/helpers/chartBuilder.js

@@ -76,7 +76,7 @@ const formatBarData = (data) => {
   return processedData;
 };
 
-const createPieChart = (columns, id, targetModal, colours) => {
+const createPieChart = (columns, id, targetModal, colours, units = null, showPieLabelRatio = true) => {
   let newChart = c3.generate({
     bindto: targetModal ? targetModal : id,
     data: {
@@ -92,13 +92,22 @@ const createPieChart = (columns, id, targetModal, colours) => {
     pie: {
       label: {
         format: function(value, ratio, id) {
-          return value + "("+Math.round(100*ratio)+"%)";
+          if (units) {
+            value = `${value} ${units}`;
+          }
+          if (showPieLabelRatio) {
+            value = `${value} (${(ratio * 100).toFixed(0)}%)`;
+          }
+          return value;
         }
       }
     },
     tooltip: {
       format: {
         value: function (value, ratio) {
+          if (units) {
+            value = `${value} ${units}`;
+          }
           return `${value} (${(ratio * 100).toFixed(0)}%)`;
         },
       },
@@ -107,7 +116,7 @@ const createPieChart = (columns, id, targetModal, colours) => {
   return newChart;
 }
 
-const createBarChart = (t, labels, columns, id, targetModal, colours, dataType) => {
+const createBarChart = (labels, columns, id, targetModal, colours, dataType, yLabel) => {
   let newChart = c3.generate({
     bindto: targetModal ? targetModal : id,
     data: {
@@ -130,11 +139,11 @@ const createBarChart = (t, labels, columns, id, targetModal, colours, dataType)
     axis: {
       x: {
         type: 'category',
-        categories: labels, 
+        categories: labels,
       },
       y: {
         label: {
-          text: t('Candidates registered', { ns: 'statistics'}),
+          text: yLabel,
           position: 'inner-top'
         },
       },
@@ -167,6 +176,7 @@ const createLineChart = (data, columns, id, label, targetModal, titlePrefix) =>
       }
     }
   }
+
   let newChart = c3.generate({
     size: {
       height: targetModal && 500,
@@ -226,10 +236,8 @@ const createLineChart = (data, columns, id, label, targetModal, titlePrefix) =>
 
           name = nameFormat(d[i].name);
           value = valueFormat(d[i].value, d[i].ratio, d[i].id, d[i].index);
-
           // Calculate percentage based on grand total of entire dataset
           let percentage = grandTotal > 0 ? ((d[i].value / grandTotal) * 100).toFixed(1) : 0;
-
           bgcolor = $$.levelColor ? $$.levelColor(d[i].value) : color(d[i].id);
 
           text += "<tr class='" + $$.CLASS.tooltipName + "-" + d[i].id + "'>";
@@ -313,9 +321,9 @@ const setupCharts = async (t, targetIsModal, chartDetails, totalLabel) => {
           }
           let chartObject = null;
           if (chart.chartType === 'pie') {
-            chartObject = createPieChart(columns, `#${chartID}`, targetIsModal && '#dashboardModal', colours);
+            chartObject = createPieChart(columns, `#${chartID}`, targetIsModal && '#dashboardModal', colours, chart.units, chart.showPieLabelRatio);
           } else if (chart.chartType === 'bar') {
-            chartObject = createBarChart(t, labels, columns, `#${chartID}`, targetIsModal && '#dashboardModal', colours, chart.dataType);
+            chartObject = createBarChart(labels, columns, `#${chartID}`, targetIsModal && '#dashboardModal', colours, chart.dataType, chart.yLabel);
           } else if (chart.chartType === 'line') {
             chartObject = createLineChart(chartData, columns, `#${chartID}`, chart.label, targetIsModal && '#dashboardModal', chart.titlePrefix);
           }

modules/statistics/jsx/widgets/recruitment.js

@@ -32,6 +32,7 @@ const Recruitment = (props) => {
           dataType: 'pie',
           label: 'Age (Years)',
           options: {pie: 'pie', bar: 'bar'},
+          yLabel: t('Candidates registered', {ns: 'statistics'}),
           legend: 'under',
           chartObject: null,
         },
@@ -42,6 +43,7 @@ const Recruitment = (props) => {
           dataType: 'pie',
           label: 'Ethnicity',
           options: {pie: 'pie', bar: 'bar'},
+          yLabel: t('Candidates registered', {ns: 'statistics'}),
           legend: 'under',
           chartObject: null,
         },
@@ -55,6 +57,7 @@ const Recruitment = (props) => {
           label: 'Participants',
           legend: '',
           options: {pie: 'pie', bar: 'bar'},
+          yLabel: t('Candidates registered', {ns: 'statistics'}),
           chartObject: null,
         },
         'siterecruitment_bysex': {
@@ -64,6 +67,7 @@ const Recruitment = (props) => {
           dataType: 'bar',
           legend: 'under',
           options: {bar: 'bar', pie: 'pie'},
+          yLabel: t('Candidates registered', {ns: 'statistics'}),
           chartObject: null,
         },
       },
@@ -75,6 +79,7 @@ const Recruitment = (props) => {
           dataType: 'line',
           legend: '',
           options: {line: 'line'},
+          yLabel: t('Candidates registered', {ns: 'statistics'}),
           chartObject: null,
         },
       },
@@ -149,6 +154,7 @@ const Recruitment = (props) => {
       setChartDetails);
   };
 
+  // Helper functions to calculate totals for each view
   const getTotalProjectsCount = () => {
     return Object.keys(json['recruitment'] || {})
       .filter((key) => key !== 'overall').length;

modules/statistics/jsx/widgets/studyprogression.js

@@ -45,7 +45,8 @@ const StudyProgression = (props) => {
         legend: 'under',
         options: {line: 'line'},
         chartObject: null,
-        titlePrefix: 'Month',
+        yLabel: t('Candidates registered', {ns: 'statistics'}),
+        titlePrefix: t('Month', {ns: 'loris'}),
       },
     },
     'total_recruitment': {
@@ -58,7 +59,25 @@ const StudyProgression = (props) => {
         legend: '',
         options: {line: 'line'},
         chartObject: null,
-        titlePrefix: 'Month',
+        yLabel: t('Candidates registered', {ns: 'statistics'}),
+        titlePrefix: t('Month', {ns: 'loris'}),
+      },
+    },
+    'project_sizes': {
+      'size_byproject': {
+        sizing: 11,
+        title: t('Dataset size breakdown by project', {ns: 'statistics'}),
+        filters: '',
+        chartType: 'pie',
+        dataType: 'pie',
+        label: t('Size (GB)', {ns: 'statistics'}),
+        units: t('GB', {ns: 'loris'}),
+        showPieLabelRatio: false,
+        legend: '',
+        options: {pie: 'pie', bar: 'bar'},
+        chartObject: null,
+        yLabel: t('Size (GB)', {ns: 'statistics'}),
+        titlePrefix: t('Project', {ns: 'loris'}),
       },
     },
   });
@@ -173,9 +192,16 @@ const StudyProgression = (props) => {
                 {showChart('total_scans', 'scans_bymonth')}
               </div>
             ) : (
-              <p>There have been no scans yet.</p>
+              <p>{t('There have been no scans yet.', {ns: 'statistics'})}</p>
             ),
             title: title('Site Scans'),
+            subtitle: t(
+              'Total Scans: {{count}}',
+              {
+                ns: 'statistics',
+                count: json['studyprogression']['total_scans'],
+              }
+            ),
             onToggleFilters: () => setShowFiltersScans((prev) => !prev),
           },
           {
@@ -212,11 +238,53 @@ const StudyProgression = (props) => {
                   {showChart('total_recruitment', 'siterecruitment_bymonth')}
                 </div>
               ) : (
-                <p>There have been no candidates registered yet.</p>
+                <p>
+                  {t(
+                    'There have been no candidates registered yet.',
+                    {ns: 'statistics'}
+                  )}
+                </p>
               ),
             title: title('Site Recruitment'),
             onToggleFilters: () => showFiltersBreakdown((prev) => !prev),
           },
+          {
+            content:
+              Object.keys(json['options']['projects']).length > 0 ? (
+                <div
+                  style={{
+                    display: 'flex',
+                    flexDirection: 'column',
+                    gap: '10px',
+                  }}
+                >
+                  <div className="btn-group" style={{marginBottom: '10px'}}>
+                  </div>
+                  {showFiltersBreakdown && (
+                    <QueryChartForm
+                      Module={'statistics'}
+                      name={'studyprogression'}
+                      id={'studyprogressionProjectSizesForm'}
+                      data={props.data}
+                      callback={(formDataObj) => {
+                        updateFilters(formDataObj, 'project_sizes');
+                      }}
+                    />
+                  )}
+                  {showChart('project_sizes', 'size_byproject')}
+                </div>
+              ) : (
+                <p>{t('There is no data yet.', {ns: 'statistics'})}</p>
+              ),
+            title: title('Project Dataset Sizes'),
+            subtitle: t(
+              'Total Size: {{count}} GB',
+              {
+                ns: 'statistics',
+                count: json['studyprogression']['total_size'] ?? -1,
+              }
+            ),
+          },
         ]}
       />
     </>

modules/statistics/php/charts.class.inc

@@ -102,6 +102,8 @@ class Charts extends \NDB_Page
             return $this->_handleSiteLineData($request);
         case 'agedistribution_line':
             return $this->_handleAgeDistributionByProject($request);
+        case 'size_byproject':
+            return $this->_handleProjectSizeBreakdown();
         default:
             return new \LORIS\Http\Response\JSON\NotFound();
         }
@@ -831,4 +833,44 @@ class Charts extends \NDB_Page
         }
         return $data;
     }
+
+    /**
+     * Handle an incoming request for project size breakdown.
+     *
+     * @return ResponseInterface
+     */
+    private function _handleProjectSizeBreakdown()
+    {
+        $DB       = \NDB_Factory::singleton()->database();
+        $user     = \NDB_Factory::singleton()->user();
+        $projects = $user->getProjects();
+
+        $cachedSizeData = json_decode(
+            html_entity_decode(
+                $DB->pselectOne(
+                    "SELECT Value
+                  FROM cached_data
+                  JOIN cached_data_type USING (CachedDataTypeID)
+                  WHERE Name='projects_disk_space'",
+                    []
+                ) ?? ''
+            ),
+            true
+        );
+
+        $projectData = [];
+        if (!is_null($cachedSizeData)) {
+            foreach ($projects as $project) {
+                $projectName = $project->getName();
+                if (in_array($projectName, array_keys($cachedSizeData))) {
+                    $projectData[] = [
+                        'label' => $projectName,
+                        ...$cachedSizeData[$projectName],
+                    ];
+                }
+            }
+        }
+
+        return (new \LORIS\Http\Response\JsonResponse($projectData));
+    }
 }