<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Bio.EUtils.DBIdsClient.DBIdsClient</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Bio-module.html">Package Bio</a> ::
<a href="Bio.EUtils-module.html">Package EUtils</a> ::
<a href="Bio.EUtils.DBIdsClient-module.html">Module DBIdsClient</a> ::
Class DBIdsClient
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Bio.EUtils.DBIdsClient.DBIdsClient-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class DBIdsClient</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.EUtils.DBIdsClient-pysrc.html#DBIdsClient">source code</a></span></p>
<p>Create a RecordSet either from a search or a set of dbids</p>
<p>The constructor takes an optional ThinClient to use for connecting to
NCBI.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">eutils</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.DBIdsClient-pysrc.html#DBIdsClient.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.EUtils.DBIdsClient.DBIdsClient-class.html#from_dbids" class="summary-sig-name">from_dbids</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">dbids</span>,
<span class="summary-sig-arg">dbtype</span>=<span class="summary-sig-default">None</span>)</span><br />
Return a RecordSet given the DBIds</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.DBIdsClient-pysrc.html#DBIdsClient.from_dbids">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.EUtils.DBIdsClient.DBIdsClient-class.html#search" class="summary-sig-name">search</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">term</span>,
<span class="summary-sig-arg">db</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">pubmed</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">field</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">retstart</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">retmax</span>=<span class="summary-sig-default">20</span>,
<span class="summary-sig-arg">daterange</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">dbtype</span>=<span class="summary-sig-default">None</span>)</span><br />
do an Entrez search</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.DBIdsClient-pysrc.html#DBIdsClient.search">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="from_dbids"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">from_dbids</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">dbids</span>,
<span class="sig-arg">dbtype</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.EUtils.DBIdsClient-pysrc.html#DBIdsClient.from_dbids">source code</a></span>
</td>
</tr></table>
<p>Return a RecordSet given the DBIds</p>
<p>This RecordSet can be used to fetch data from NCBI related to the
given DBIds.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="search"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">search</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">term</span>,
<span class="sig-arg">db</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">pubmed</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">field</span>=<span class="sig-default">None</span>,
<span class="sig-arg">retstart</span>=<span class="sig-default">0</span>,
<span class="sig-arg">retmax</span>=<span class="sig-default">20</span>,
<span class="sig-arg">daterange</span>=<span class="sig-default">None</span>,
<span class="sig-arg">dbtype</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.EUtils.DBIdsClient-pysrc.html#DBIdsClient.search">source code</a></span>
</td>
</tr></table>
<pre class="literalblock">
do an Entrez search
The parameters are:
'term' -- the query string in the Entrez query language; see
http://www.ncbi.nlm.nih.gov/entrez/query/static/help/pmhelp.html
'db' -- the database to search
'field' -- the field to use for unqualified words
Eg, "dalke[au] AND gene" with field==None becomes
dalke[au] AND (genes[MeSH Terms] OR gene[Text Word]
and "dalke[au] AND gene" with field=="au" becomes
dalke[au] AND genes[Author]
(Yes, I think the first "au" should be "Author" too)
'retstart' -- include identifiers in the output, starting with
position 'retstart' (normally starts with 0)
'retmax' -- return at most 'retmax' identifiers in the output
(if not specified, NCBI returns 20 identifiers)
'daterange' -- a date restriction; either WithinNDays or DateRange
'dbtype' -- (optional) the database type (Config.PUBLICATION_TYPE
or SEQUENCE_TYPE). Overrides the type based on the 'db'
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:31 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
