* The Jalview Authors are detailed in the 'AUTHORS' file.
-->
<head>
-<title>PDB Sequence Fetcher</title>
+<title>The PDB Sequence Fetcher</title>
</head>
<body>
- <strong>PDB Sequence Fetcher</strong>
- <p>From Jalview 2.x.x a speciliased interface was introduced for
- fast and efficient discovery/retrieval of sequence data from the PDB
- database. The introduced interface enables live querying of PDB data
- on-the-fly thereby eliminating the need to memorise database accession
- or to cross-reference other bioinformatics websites before retrieving
- a sequence data in jalview. The underlying technology is provided by
- EBI and is based on Apache Solr which is a text based search engine.</p>
+ <strong>The PDB Sequence Fetcher</strong>
+ <p>
+ Jalview provides a specialised interface that allows fast and
+ efficient discovery and retrieval of data from the PDB database,
+ based on the EMBL-EBI's PDBe BioSOLR query interface. It allows
+ interactive querying of PDB metadata with free text and structured
+ queries, so structures can be located without prior knowledge of
+ their database accessions, or <em>via</em> manual cross-referencing
+ with other bioinformatics websites.
+ </p>
+ <p>
+ To open the PDB Sequence Fetcher, select PDB as the database from
+ any <a href="seqfetch.html">Sequence Fetcher</a> dialog (opened <em>via</em>
+ <strong>"File →Fetch Sequences"</strong>).
+ </p>
+ <img src="pdbseqfetcher.png" align="left"
+ alt="PDB sequence fetcher (introduced in Jalview 2.9)" />
- <p>
- The PDB Sequence Fetcher interface can be opened by selecting <strong>PDB</strong>
- as the choice database from the <strong>'Select Database
- Retrieval Source'</strong> interface of <a href="seqfetch.html">Sequence
- Fetcher</a>.
- </p><br>
+ <p>
+ <a name="pdbfts"><strong>Searching the PDB Database</strong></a>
+ </p>
+ <p>To search the PDB, begin typing in the text box. If the
+ 'autosearch' checkbox is enabled, then the results of your query
+ will be automatically updated and shown in the search results tab;
+ otherwise, press return to update the results. To access previous
+ searches, press the down-arrow or click the drop down menu icon at
+ the side of the search box. If you just want to paste in a list of
+ IDs, the 'Retrieve IDs' tab provides a batch-retrieval interface.</p>
+ <p>
+ You can sort results according to the displayed columns, and select
+ entries with the mouse and keyboard. Once you have selected one or
+ more entries, hit the <strong>OK</strong> button to retrieve and
+ view them in Jalview.
+ </p>
+ <p>
+ <ul>
+ <li><strong>Searching a specific PDB field</strong><br />If
+ you want to find structures based on a specific PDB metadata
+ field, you can select it from the drop-down menu.</li>
+ <li><strong>Retrieving a unique chain for a PDB entry</strong><br>To
+ retrieve a specific chain for a PDB entry, append the PDB ID with
+ a colon followed by the chain code in the search box.<br /> e.g
+ 1xyz:A</li>
- <img src="pdbseqfetcher.png" align="left"
- alt="PDB sequence fetcher (introduced in Jalview 2.x.x)">
-
- <br>
- <p>
- <strong>Searching the PDB Database</strong><br> Once the
- interface is opened, typing in the search text box will execute a live
- query to the PDB database and display the results on-the-fly as seen
- in the screen-shot above. Use the drop-down menu to select a specific
- field to search by in the PDB database, the default option is <strong>'ALL'</strong>.
- <br>
-
- <br>Wild card searching: The PDB sequence fetcher also provides support for wild card querying of the PDB database.
- <br>Single character (matches a single character) - ?
- The search string te?t would match both test and text.
+ <li><strong>Bulk PDB retrieval</strong><br>Multiple PDB
+ IDs can be specified for retrieval via the
+ <strong>Retrieve IDs</strong> tab.</li>
-<br>Multiple characters (matches zero or more sequential characters) - *
-
-The wildcard search:
-tes* - would match test, testing, and tester.
-
-
-You can also use wildcard characters in the middle of a term. For
-example:
-te*t - would match test and text.
-*est - would match pest and test.
- </p>
-
- <p>
- <strong>Customising displayed meta-data</strong> <br>To change the
- displayed meta-data in the search result, click the <strong>'Configure
- Displayed Columns'</strong> tab, then tick off the options wanted.
- </p>
- <p><strong>Importing Sequence</strong><br>
- After querying the PDB database, to import the found data into Jalview, select the entries you wish to import then click the ok button at the bottom of the interface.</p>
- <p>
- <em>The PDB Sequence Fetcher interface was introduced in Jalview
- 2.x.x.</em>
- </p>
+ <li><strong>Wild card searching</strong><br>The following
+ wild cards are supported by the EMBL-EBI PDBe query service:
+ <ul>
+ <li><strong>?</strong> matches a single character<br />The
+ search string te?t would match both test and text.</li>
+ <li><strong>*</strong> matches multiple characters<br />The
+ search string: tes* - would match test, testing, and tester.</li>
+ </ul> <em>Note:</em> you can use wildcard characters anywhere in a
+ query string.<br />For example: te*t - would match test and text.
+ *est - would match pest and test.</li>
+ <li><strong>Structured queries</strong><br />The PDBe SOLR
+ interface supports boolean query syntax, allowing quoted search
+ strings to be combined with AND, OR, and NOT. Currently, no
+ special support for constructing these queries is provided in the
+ query dialog box.</li>
+ </ul>
+ <p>
+ <strong>Customising The PDB Sequence Fetcher</strong>
+ </p>
+ <p>
+ To change the displayed meta-data in the search result, click the
+ 'Configure Displayed Columns' tab, and select the fields you'd like
+ displayed. These fields can also be configured <em>via</em> the
+ Structure tab of the <a href="preferences.html#structure">Jalview
+ Desktop Preferences</a>.
+ </p>
+ <p>
+ <em>The PDB Sequence Fetcher interface was introduced in
+ Jalview 2.9</em>
+ </p>
</body>
</html>
\ No newline at end of file
git://source.jalview.org / jalview.git / blobdiff