Swap metric and metric type

Author: nils-herrmann

docs/reference/scival/InstitutionMetrics.rst

@@ -51,17 +51,21 @@ Each metric property returns a list of `MetricData` namedtuples with the structu
 
     >>> institution_metrics.CitationCount
     [MetricData(entity_id=309021, entity_name='Humboldt University of Berlin', metric='CitationCount', 
-                metric_type=None, year='all', value=368527, percentage=None, threshold=None)]
+                metric_type='CitationCount', year='all', value=368527, percentage=None, threshold=None)]
+
+For **nested metrics** (like CollaborationImpact), `metric_type` contains the main category and `metric` contains the specific sub-type:
+
+.. code-block:: python
 
     >>> institution_metrics.CollaborationImpact
-    [MetricData(entity_id=309021, entity_name='Humboldt University of Berlin', metric='CollaborationImpact', 
-                metric_type='Institutional collaboration', year='all', value=8.610204, percentage=None, threshold=None),
-     MetricData(entity_id=309021, entity_name='Humboldt University of Berlin', metric='CollaborationImpact', 
-                metric_type='International collaboration', year='all', value=22.430689, percentage=None, threshold=None),
-     MetricData(entity_id=309021, entity_name='Humboldt University of Berlin', metric='CollaborationImpact', 
-                metric_type='National collaboration', year='all', value=9.935493, percentage=None, threshold=None),
-     MetricData(entity_id=309021, entity_name='Humboldt University of Berlin', metric='CollaborationImpact', 
-                metric_type='Single authorship', year='all', value=3.187361, percentage=None, threshold=None)]
+    [MetricData(entity_id=309021, entity_name='Humboldt University of Berlin', metric='Institutional collaboration', 
+                metric_type='CollaborationImpact', year='all', value=8.610204, percentage=None, threshold=None),
+     MetricData(entity_id=309021, entity_name='Humboldt University of Berlin', metric='International collaboration', 
+                metric_type='CollaborationImpact', year='all', value=22.430689, percentage=None, threshold=None),
+     MetricData(entity_id=309021, entity_name='Humboldt University of Berlin', metric='National collaboration', 
+                metric_type='CollaborationImpact', year='all', value=9.935493, percentage=None, threshold=None),
+     MetricData(entity_id=309021, entity_name='Humboldt University of Berlin', metric='Single authorship', 
+                metric_type='CollaborationImpact', year='all', value=3.187361, percentage=None, threshold=None)]
 
 **Available Metric Properties**:
 
@@ -133,8 +137,8 @@ You can retrieve all available metrics in a single list using the `all_metrics`
         <th>0</th>
         <td>309021</td>
         <td>Humboldt University of Berlin</td>
-        <td>AcademicCorporateCollaboration</td>
         <td>Academic-corporate collaboration</td>
+        <td>AcademicCorporateCollaboration</td>
         <td>all</td>
         <td>1015.000000</td>
         <td>4.469594</td>
@@ -144,8 +148,8 @@ You can retrieve all available metrics in a single list using the `all_metrics`
         <th>1</th>
         <td>309021</td>
         <td>Humboldt University of Berlin</td>
-        <td>AcademicCorporateCollaboration</td>
         <td>No academic-corporate collaboration</td>
+        <td>AcademicCorporateCollaboration</td>
         <td>all</td>
         <td>21694.000000</td>
         <td>95.530410</td>
@@ -155,8 +159,8 @@ You can retrieve all available metrics in a single list using the `all_metrics`
         <th>2</th>
         <td>309021</td>
         <td>Humboldt University of Berlin</td>
-        <td>AcademicCorporateCollaborationImpact</td>
         <td>Academic-corporate collaboration</td>
+        <td>AcademicCorporateCollaborationImpact</td>
         <td>all</td>
         <td>59.104435</td>
         <td>NaN</td>
@@ -166,8 +170,8 @@ You can retrieve all available metrics in a single list using the `all_metrics`
         <th>3</th>
         <td>309021</td>
         <td>Humboldt University of Berlin</td>
-        <td>AcademicCorporateCollaborationImpact</td>
         <td>No academic-corporate collaboration</td>
+        <td>AcademicCorporateCollaborationImpact</td>
         <td>all</td>
         <td>14.222181</td>
         <td>NaN</td>

pybliometrics/scival/tests/test_InstitutionMetrics.py

@@ -39,8 +39,8 @@ def test_all_metrics():
     result = single_institution_all.all_metrics
     expected_result_0 =MetricData(entity_id=505023,
                                   entity_name='Universidad Nacional Autónoma de México',
-                                  metric='AcademicCorporateCollaboration',
-                                  metric_type='Academic-corporate collaboration',
+                                  metric='Academic-corporate collaboration',
+                                  metric_type='AcademicCorporateCollaboration',
                                   year='all',
                                   value=951,
                                   percentage=2.31415,
@@ -52,7 +52,7 @@ def test_all_metrics():
     expected_result_multi_last = MetricData(entity_id=309086,
                                             entity_name='Ludwig Maximilian University of Munich',
                                             metric='OutputsInTopCitationPercentiles',
-                                            metric_type=None,
+                                            metric_type='OutputsInTopCitationPercentiles',
                                             year='2023',
                                             value=3792,
                                             percentage=38.50528,