specparam.reports.methods.methods_report_info

specparam.reports.methods.methods_report_info(model_obj=None, concise=False)[source]

Prints out a report of information required for methods reporting.

Parameters:
model_objSpectralModel or SpectralGroupModel, optional

An object with setting information available. If provided, is used to collect and print information to be reported.

concisebool, optional, default: False

Whether to print the report in concise mode.

Notes

Any missing values (information that is not available) will be printed out as ‘XX’.

Examples using specparam.reports.methods.methods_report_info

10: Reporting & Referencing

10: Reporting & Referencing