add data str report

Author: TomDonoghue

specparam/reports/strings.py

@@ -118,6 +118,56 @@ def gen_version_str(concise=False):
     return output
 
 
+def gen_data_str(data, concise=False):
+    """Generate a string representation summarizing current data.
+
+    Parameters
+    ----------
+    data : Data
+        Data object to summarize data for.
+        Can also be any derived data object (e.g. Data2D).
+    concise : bool, optional, default: False
+        Whether to print the report in concise mode.
+
+    Returns
+    -------
+    output : str
+        Formatted string of data summary.
+    """
+
+    # Get number of spectra, checking attributes for {Data3D, Data2DT, Data2D, Data}
+    if getattr(data, 'n_events', None):
+        n_spectra_str = '{} spectrograms with {} windows each'.format(data.n_events, data.n_time_windows)
+    elif getattr(data, 'n_time_windows', None):
+        n_spectra_str = '1 spectrogram with {} windows'.format(data.n_time_windows)
+    elif getattr(data, 'n_spectra', None):
+        n_spectra_str = '{} power spectra'.format(data.n_spectra)
+    else:
+        n_spectra_str = '1 power spectrum'
+
+    if not data.has_data:
+
+        no_data_str = "No data currently loaded in the object."
+        str_lst = [DIVIDER,'', no_data_str, '', DIVIDER]
+
+    else:
+
+        str_lst = [
+
+            DIVIDER,
+            '',
+            'The data object contains {}'.format(n_spectra_str),
+            'with a frequency range of {} Hz'.format(data.freq_range),
+            'and a frequency resolution of {} Hz.'.format(data.freq_res),
+            '',
+            DIVIDER,
+        ]
+
+    output = _format(str_lst, concise)
+
+    return output
+
+
 def gen_modes_str(modes, description=False, concise=False):
     """Generate a string representation of fit modes.
 

specparam/tests/reports/test_strings.py

@@ -14,6 +14,13 @@ def test_gen_version_str():
 
     assert gen_version_str()
 
+def test_gen_data_str(tdata, tdata2d, tdata2dt, tdata3d):
+
+    assert gen_data_str(tdata)
+    assert gen_data_str(tdata2d)
+    assert gen_data_str(tdata2dt)
+    assert gen_data_str(tdata3d)
+
 def test_gen_modes_str(tfm):
 
     assert gen_modes_str(tfm.modes)