Skip to content

Commit 13a72b8

Browse files
updated documentation on intermediate files
1 parent 4cce1f6 commit 13a72b8

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/source/userguide/input-files.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ Check the list of :py:mod:`psm_utils` tags in the
2929
file extension, the file type can also be inferred from the file name. In that case,
3030
``psm_file_type`` option can be set to ``infer``.
3131

32+
.. note::
33+
If a previous MS²Rescore run crashed during feature generation or rescoring, an intermediate
34+
file (``<prefix>.intermediate.psms.tsv``) is automatically saved. This file contains all PSMs
35+
with features that were successfully added up to that point. You can resume processing by
36+
providing this file as the PSM file (``-p <prefix>.intermediate.psms.tsv -t tsv``) to skip
37+
already completed feature generation steps.
38+
3239

3340
Spectrum file(s)
3441
================

docs/source/userguide/output-files.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ Log and configuration files:
3131
+--------------------------------------+--------------------------------------------------------------------------------------+
3232
| ``<prefix>.feature_names.tsv`` | List of the features and their descriptions |
3333
+--------------------------------------+--------------------------------------------------------------------------------------+
34+
| ``<prefix>.intermediate.psms.tsv`` | Created automatically if the process crashes during feature generation or rescoring. |
35+
| | Contains all PSMs with successfully added features up to the crash point. Can be |
36+
| | used to resume processing with ``-p <prefix>.intermediate.psms.tsv -t tsv``. |
37+
+--------------------------------------+--------------------------------------------------------------------------------------+
3438

3539
Rescoring engine files:
3640

0 commit comments

Comments
 (0)