Revising submitted sequences

Contents:

Sequences can be corrected or updated after they have been submitted to Pathoplexus. Submitting these changes (“revisions”) will cause the version of the sequence to be incremented, and previous versions of the metadata and sequence data can always be accessed via previous version numbers. (See Versioning)

You can revise sequences via the website (particularly good for a small number of sequences and relatively simple edits), or by reuploading updated files (good for large numbers of sequences, or more extensive revisions - but requires the original data files that were submitted, see docs below on how to download the original data from Loculus!)

Editing in the website

The easiest way to revise your sequences, especially for a small number of sequences, is to edit them directly on the Pathoplexus website. Here’s how:

Accessing your sequences

  1. Navigate to the organism you want to revise sequences for
  2. Click ‘Submit sequences’ in the top sub-menu
  3. Click ‘View’ to display your previously submitted sequences for that organism

Starting a revision

  1. Open the sequence in question
  2. Scroll to the bottom of the sequence’s page
  3. You’ll see a ‘Revise this sequence’ button (this button is only visible to the group that originally submitted the sequence)
  4. Click this button to open the revision page

Making your edits

On the revision page, you can:

  • Edit metadata fields: All metadata fields are directly editable in the form
  • Replace the alignment file: You can discard the current alignment file and upload a new one
  • Add or remove raw reads: You can upload additional raw read files or discard raw reads files currently associated with the sequence
  • Undo changes: As you edit, a curved arrow symbol appears to the right of each field. Click this arrow to revert that field to its current value if you want to undo any changes

Submitting your revisions

  1. Once you’ve finished making all your edits, click the ‘Submit’ button at the bottom of the page
  2. Confirm that you’re ready to submit

You’ll then be taken to a review page similar to the initial submission dialog. This page shows all sequences for which you’ve made revisions.

Important: Before your changes are made visible in the database, you must click ‘Approve valid sequences’ - this is the same as with initial submissions, and without it, the changes will not take effect.

You can approve changes immediately as you revise sequences one by one, or you can revise multiple sequences and then approve them all together.

Editing using files

Submitting revisions using modified files is very similar to making an original submission.

The main difference is that revision metadata must include an accession column containing the Pathoplexus accession assigned during the original submission.

Important: The accession column should contain the accession without the version number. For example, use PP_0049AAG rather than PP_0049AAG.1. (See Accessions for more information on accession format.)

Whenever possible, use the original metadata and sequence files from your initial Pathoplexus submission as the starting point for your revision. You can either use your own copies of these files or download them from Pathoplexus.

Preparing revision files

The easiest way to prepare revision files is to download your original submission data:

  1. Navigate to the organism you want to revise sequences for.
  2. Click Submit sequences in the top sub-menu.
  3. Click View to display your previously submitted sequences for that organism.
  4. Search for and select the entries you would like to revise and click Download original data.
  5. A zip folder containing the original metadata and FASTA files will be downloaded. Make your edits directly to these files.

Pathoplexus automatically adds the required accession column to downloaded metadata.

Alternatively, if you already have the original submission files, you can edit those directly. Add an accession column to the metadata file containing the Pathoplexus accessions assigned during the original submission.

Your revision upload must always include:

  • a metadata file containing only the entries you want to revise
  • a matching FASTA file containing the corresponding sequences

For single-segmented organisms, FASTA sequence IDs must match the values in the metadata id column.

For multi-segmented organisms, include a fastaIds column in the metadata file containing a space-separated list of all FASTA IDs linked to each metadata entry.

We encourage you to add a short description of your changes in the optional versionComment metadata field explaining the reason for the revision.

Editing the metadata

To revise metadata, edit the relevant fields in your metadata file. The metadata file should include all the metadata fields that were originally included, both those that you wish to update and those that should remain the same. (Not including a metadata column will set its value to ‘empty’.)

The FASTA file does not need to be modified if the sequences are unchanged, but you must still include a matching FASTA file when submitting the revision.

Editing the sequence

To revise sequences, edit the relevant sequences in the FASTA file.

The sequence IDs do not need to be changed as long as they still match the corresponding metadata entries (id for single-segmented organisms or fastaIds for multi-segmented organisms).

You can also revise metadata fields at the same time by editing the metadata file.

Editing the raw reads

By default, revising the metadata or sequence data will not affect the raw reads files attached to your submissions. The Download original data metadata file is prepropulated with a files.rawReads column that links each entry to your already-uploaded files. This means that if you don’t want to update the raw reads data of your submission you do not need to re-upload the raw reads files and do not need to perform any additional action besides making the metadata or sequence edits you want; just ensure that you leave the files.rawReads column exactly as it was when you downloaded the original data.

If you do want to change the raw reads files associated with your submission, you will need to edit the files.rawReads column in the metadata file according to the instructions below:

  • Adding additional raw reads files: in your metadata file, find the entry for which you want to add a raw reads file. Add the name of the file to the files.rawReads field (see here for a detailed description), and upload the file via the ‘Upload folder’ or ‘Upload files’ functionality during submission.
  • Discarding previously uploaded raw reads files: in your metadata file, find the entry for which you want to delete a raw reads file. Go to the files.rawReads field and remove the name of the file you wish to delete. The name will be shown as name:fileId, where fileId is the internal accession Pathoplexus assigned to the file. Please ensure to remove to full name:fileId entry from your metadata file in order to delete the raw reads.
  • Replacing a previously uploaded raw reads file with another one: this can be done through a combination of the two approaches outlined above: first, identify the name:fileId of the file you want to replace, replace it with the new file name, and upload the corresponding file via the ‘Upload folder’ or ‘Upload files’ functionality during submission.

Submitting the revision

To submit a revision, navigate to the Submit section of the Pathoplexus website using the link in the top-right corner of the website. Select the correct pathogen if requested, or ensure you’re submitting to the correct pathogen database via the drop-down on the top-left of the website.

When on the page with ‘Submit’, ‘Revise’, ‘Review’, and ‘View’ boxes, select ‘Revise’.

Just as with an original submission, drag and drop (or select) the files where you have made the appropriate revisions. Ensure you specify the same Terms of Data as you previously chose for your sequences. Press ‘Upload and proceed to Approval’.

You will be directed to the same processing page as you’re taken to during initial submission, where you can view the sequences and their changes before approving them. Once approved, these changes will appear in the database after a few minutes, with the version numbers incremented.