Skip to content

Commit

Permalink
Document submission_template flag in loci table.
Browse files Browse the repository at this point in the history
  • Loading branch information
kjolley committed Jun 22, 2015
1 parent 76287c1 commit ca4b60c
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 3 deletions.
5 changes: 5 additions & 0 deletions administration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -793,6 +793,11 @@ Fill in the web form with appropriate values. Required fields have an exclamatio
* url - The URL used to hyperlink to information about the allele. This can either be a relative or absolute URL. If [?] (including the square brackets) is included then this will be substituted for the allele value in the resultant URL. To link to the appropiate allele info page on a corresponding seqdef database you would need something like /cgi-bin/bigsdb/bigsdb.pl?db=pubmlst_neisseria_seqdef&page=alleleInfo&locus=abcZ&allele_id=[?].

* Allowed: any valid URL.

* submission_template - Sets whether or not a column for this locus is
included in the Excel submission template.

* Allowed: true/false (default: false)

.. index::
single: locus; adding; copying existing record
Expand Down
40 changes: 37 additions & 3 deletions submissions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,10 @@ how the sequence was obtained:
Paste in sequence(s)
====================
Paste in the new variant sequences to the box. This can either be a stand-
alone sequence or multiple sequences in FASTA format. Click submit.
alone sequence or multiple sequences in FASTA format. The sequences must be
trimmed to the start and end points of the loci - check existing allele
definitions if in doubt. The submission is likely to be rejected if sequences
are not trimmed. Click submit.

.. image:: /images/submissions/submission6.png

Expand Down Expand Up @@ -180,7 +183,7 @@ management page.

.. image:: /images/submissions/submission16.png

Download the Excel submission template
Download the Excel submission template.

.. image:: /images/submissions/submission17.png

Expand Down Expand Up @@ -236,4 +239,35 @@ Click 'Finalize submission!'.
Your submission will then be listed under 'Pending submissions' on your
submission page.

.. image:: /images/submissions/submission23.png
.. image:: /images/submissions/submission23.png

******************
Isolate submission
******************
New isolate data can only be submitted from within the appropriate isolate
database. You may be required to submit isolate data if you would like to get
a new MLST sequence type defined, but this depends on individual database
policy.

Start
=====
Click the 'isolates' link under submission type on the submission management
page.

.. image:: /images/submissions/submission24.png

Download the Excel submission template.

.. image:: /images/submissions/submission25.png

Fill in the template. Some fields are required and cannot be left blank.
Check the 'Description of database fields' link on the database contents page
to see a description of the fields and allowed values where these have been
defined. Where allowed values have been set, the template will have dropdown
boxes (although these require newer versions of Excel to work).

Some databases may have hundreds of loci defined, and most will not have a
column in the template. You can add new columns for any loci that have been
defined and for which you would like to include allelic information for.
These locus names must be the primary locus identifier. A list of loci can be
found in the 'allowed_loci' tab of the Excel submission template.

0 comments on commit ca4b60c

Please sign in to comment.