Logo Search packages:      
Sourcecode: python-biopython version File versions

def Bio::EUtils::ThinClient::ThinClient::elink_using_history (   self,
  dbfrom,
  webenv,
  query_key,
  db = "pubmed",
  retstart = 0,
  retmax = 20,
  cmd = "neighbor",
  retmode = None,
  term = None,
  field = None,
  daterange = None 
)

dbfrom, webenv, query_key, db="pubmed", retstart=0, retmax=20, cmd="neighbor", retmode=None, term=None, field=None, daterange=None, 

Find records related (in various ways) to a collection of
records in the history.

'dbfrom' -- this is the name of the database containing the
      collection of record.  NOTE!  For the other methods
      this is named 'db'.  But I'm keeping NCBI's notation.
      This is where the records come FROM.
'webenv' -- the WebEnv cookie for the history
'query_key' -- the collection in the history

'db' -- Where the records link TO.  This is where you want to
  find the new records.  For example, if you want to
  find PubMed records related to a protein then 'dbfrom'
  is 'protein' and 'db' is 'pubmed'

'cmd'-- one of the following (unless specified, retmode is the
      default value, which returns data in XML)
   neighbor:  Display neighbors and their scores by database and ID.
         (This is the default 'cmd'.)
   prlinks: List the hyperlink to the primary LinkOut provider
         for multiple IDs and database.
    When retmode == 'ref' this URL redirects the browser
         to the primary LinkOut provider for a single ID
         and database.
   llinks:  List LinkOut URLs and Attributes for multiple IDs
         and database.
   lcheck:  Check for the existence (Y or N) of an external
         link in for multiple IDs and database.
   ncheck:  Check for the existence of a neighbor link for
         each ID, e.g., Related Articles in PubMed.

'retstart' -- get the formatted data starting with this position
'retmax' -- get data for at most this many records

'retmode' -- only used with 'prlinks'

'term' -- restrict results to records which also match this
         Entrez search
'field' -- the field to use for unqualified words

'daterange' -- restrict results to records which also match this
         date criteria; either WithinNDays or DateRange
         NOTE: DateRange must have both mindate and maxdate

Some examples:
  In PubMed, to get a list of "Related Articles"
    dbfrom = pubmed
    cmd = neighbor

  To get MEDLINE index only related article
    dbfrom = pubmed
    db = pubmed
    term = medline[sb]
    cmd = neighbor

  Given a PubMed record, find the related nucleotide records
    dbfrom = pubmed
    db = nucleotide  (or "protein" for related protein records)
    cmd = neighbor

  To get "LinkOuts" (external links) for a PubMed record set
    dbfrom = pubmed
    cmd = llinks

  Get the primary link information for a PubMed document; includes
      various hyperlinks, image URL for the provider, etc.
    dbfrom = pubmed
    cmd = prlinks
    (optional) retmode = "ref" (causes a redirect to the privder)

Returns an input stream from an HTTP request.  The stream
contents are in XML unless 'retmode' is 'ref'.

Definition at line 1001 of file ThinClient.py.

                             :
        """dbfrom, webenv, query_key, db="pubmed", retstart=0, retmax=20, cmd="neighbor", retmode=None, term=None, field=None, daterange=None, 

        Find records related (in various ways) to a collection of
        records in the history.

        'dbfrom' -- this is the name of the database containing the
                      collection of record.  NOTE!  For the other methods
                      this is named 'db'.  But I'm keeping NCBI's notation.
                      This is where the records come FROM.
        'webenv' -- the WebEnv cookie for the history
        'query_key' -- the collection in the history

        'db' -- Where the records link TO.  This is where you want to
                  find the new records.  For example, if you want to
                  find PubMed records related to a protein then 'dbfrom'
                  is 'protein' and 'db' is 'pubmed'

        'cmd'-- one of the following (unless specified, retmode is the
                      default value, which returns data in XML)
           neighbor:  Display neighbors and their scores by database and ID.
                         (This is the default 'cmd'.)
           prlinks: List the hyperlink to the primary LinkOut provider
                         for multiple IDs and database.
                    When retmode == 'ref' this URL redirects the browser
                         to the primary LinkOut provider for a single ID
                         and database.
           llinks:  List LinkOut URLs and Attributes for multiple IDs
                         and database.
           lcheck:  Check for the existence (Y or N) of an external
                         link in for multiple IDs and database.
           ncheck:  Check for the existence of a neighbor link for
                         each ID, e.g., Related Articles in PubMed.

        'retstart' -- get the formatted data starting with this position
        'retmax' -- get data for at most this many records

        'retmode' -- only used with 'prlinks'

        'term' -- restrict results to records which also match this
                         Entrez search
        'field' -- the field to use for unqualified words

        'daterange' -- restrict results to records which also match this
                         date criteria; either WithinNDays or DateRange
                         NOTE: DateRange must have both mindate and maxdate

        Some examples:
          In PubMed, to get a list of "Related Articles"
            dbfrom = pubmed
            cmd = neighbor

          To get MEDLINE index only related article
            dbfrom = pubmed
            db = pubmed
            term = medline[sb]
            cmd = neighbor

          Given a PubMed record, find the related nucleotide records
            dbfrom = pubmed
            db = nucleotide  (or "protein" for related protein records)
            cmd = neighbor

          To get "LinkOuts" (external links) for a PubMed record set
            dbfrom = pubmed
            cmd = llinks

          Get the primary link information for a PubMed document; includes
              various hyperlinks, image URL for the provider, etc.
            dbfrom = pubmed
            cmd = prlinks
            (optional) retmode = "ref" (causes a redirect to the privder)
        
        Returns an input stream from an HTTP request.  The stream
        contents are in XML unless 'retmode' is 'ref'.
        """
        query = {"WebEnv": webenv,
                 "query_key": query_key,
                 "db": db,
                 "dbfrom": dbfrom,
                 "cmd": cmd,
                 "retstart": retstart,
                 "retmax": retmax,
                 "retmode": retmode,
                 "term": term,
                 "field": field,
                 }
        if daterange is not None:
            if daterange.mindate is None or daterange.maxdate is None:
                raise TypeError("Both mindate and maxdate must be set for eLink")
            query.update(daterange.get_query_params())
        return self._get(program = "elink.fcgi", query = query)


    def elink_using_dbids(self,


Generated by  Doxygen 1.6.0   Back to index