Skip to content

OUTPUT_GUIDE.md

Latest commit

 

History

History
157 lines (98 loc) · 4.79 KB

OUTPUT_GUIDE.md

File metadata and controls

157 lines (98 loc) · 4.79 KB
Raw

Output Guide

This guide explains the main output files generated by the Peel Trace Evaluation for Soft Substrates workflow.

The notebook generates per-trace metrics, group summaries, diagnostic tables, QC plots, audit files, and provenance records. The exact output set can vary depending on the input data, selected profile, and whether the run completes without warnings or failures.

1. Start here

After a successful run, inspect outputs in this order:

  1. analysis_report.xlsx
  2. qc_plots/
  3. paper_metrics.csv
  4. group_summary.csv
  5. diagnostic_summary.csv
  6. output_consistency_audit.csv
  7. provenance.json

The QC plots should be reviewed before interpreting the numerical metrics.

2. analysis_report.xlsx

This is the main human-readable workbook.

It may include:

  • per-trace metrics;
  • group summaries;
  • diagnostic tables;
  • formula definitions;
  • metric interpretation notes;
  • output-consistency checks;
  • provenance information.

Use this file as the first place to inspect the complete run output.

3. paper_metrics.csv

This file contains per-trace manuscript-baseline metrics and quality flags.

Typical columns may include:

  • group label;
  • adhesive label;
  • replicate identifier;
  • Fc/w;
  • Fci/w;
  • Peel Stability Index, PSI;
  • stick–slip amplitude, SSA;
  • selected-window coefficient of variation;
  • drift ratio;
  • peak and trough counts;
  • displacement or break proxy;
  • analysis-status and quality flags.

Use this file when you need trace-level values for plotting, checking, or manuscript tables.

4. group_summary.csv

This file summarizes replicate-level results by group and adhesive.

Typical outputs include:

  • mean;
  • sample standard deviation;
  • coefficient of variation;
  • replicate count.

Use this file for group-level comparisons.

5. qc_plots/

This folder contains trace-level quality-control plots.

Use the plots to check whether:

  • the selected window is located in a mechanically reasonable part of the trace;
  • Top5 maxima and Bottom5 minima are distributed appropriately;
  • the trace contains strong stick–slip behavior;
  • the selected window is dominated by noise, drift, or terminal failure behavior;
  • the reported metrics are visually consistent with the trace.

Do not rely only on numeric metrics if the QC plot shows an unreasonable selected window or extraction pattern.

6. diagnostic_summary.csv

This file separates run status, metric-quality status, and export-integrity information.

Use it to identify:

  • traces that passed;
  • traces that generated warnings;
  • traces that failed metric extraction;
  • traces where user review is required.

Built-in Scotch Tape reference validation is handled separately from user-run diagnostics.

7. issue_action_table.csv

This file maps common warnings or failures to conservative next actions.

Use this file when a trace fails or generates warnings and you need to decide whether to inspect units, adjust mapping, review QC plots, or run a modified recovery analysis.

8. validation_count_summary.csv

This file explains the number and purpose of validation or audit checks.

The number of checks can change depending on the exported table schemas and available outputs.

9. output_consistency_audit.csv

This file checks whether exported CSV and Excel values match the in-memory calculated tables.

If this audit fails, do not use the exported CSV or Excel outputs until the analysis is rerun or debugged.

Export consistency confirms file-writing integrity. It does not replace mechanical review of the traces.

10. formula_dictionary.csv

This file lists metric equations, units, and short interpretations.

Use it to verify how reported quantities were calculated.

11. metric_guide.csv

This file gives plain-language interpretation notes and limitations.

Use it when explaining the meaning of Fc/w, Fci/w, PSI, SSA, selected-window CV, drift ratio, and related descriptors.

12. provenance.json

This file records run-level provenance information.

It may include:

  • software version;
  • backend version;
  • timestamp;
  • input-file hash;
  • selected method profile;
  • output paths.

Use this file to support reproducibility.

13. manuscript_baseline_outputs.zip

This archive collects key outputs from the manuscript-baseline run.

Use it for sharing or archiving the primary output set after QC review.

14. Interpretation caution

The output files contain protocol-defined descriptors of measured peel response.

They should not be interpreted as intrinsic adhesive material constants without additional assumptions, substrate-deformation checks, and fracture-mechanics interpretation.

For soft substrates, peel traces can include contributions from interfacial separation, peel-arm deformation, compliance, viscoelastic or plastic dissipation, stick–slip behavior, and test configuration.