.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Bio::Annotation::Reference 3pm"
.TH Bio::Annotation::Reference 3pm "2021-08-15" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Bio::Annotation::Reference \- Specialised DBLink object for Literature References
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&    $reg = Bio::Annotation::Reference\->new( \-title    => \*(Aqtitle line\*(Aq,
\&                                            \-location => \*(Aqlocation line\*(Aq,
\&                                            \-authors  => \*(Aqauthor line\*(Aq,
\&                                            \-medline  => 998122 );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Object which presents a literature reference. This is considered to be
a specialised form of database link. The additional methods provided
are all set/get methods to store strings commonly associated with
references, in particular title, location (ie, journal page) and
authors line.
.PP
There is no attempt to do anything more than store these things as
strings for processing elsewhere. This is mainly because parsing these
things suck and generally are specific to the specific format one is
using. To provide an easy route to go format \-\-> object \-\-> format
without losing data, we keep them as strings. Feel free to post the
list for a better solution, but in general this gets very messy very
fast...
.SH "AUTHOR \- Ewan Birney"
.IX Header "AUTHOR - Ewan Birney"
Email birney@ebi.ac.uk
.SH "APPENDIX"
.IX Header "APPENDIX"
The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a _
.SS "new"
.IX Subsection "new"
.Vb 10
\& Title   : new
\& Usage   : $ref = Bio::Annotation::Reference\->new( \-title => \*(Aqtitle line\*(Aq,
\&                           \-authors => \*(Aqauthor line\*(Aq,
\&                           \-location => \*(Aqlocation line\*(Aq,
\&                           \-medline => 9988812);
\& Function:
\& Example :
\& Returns : a new Bio::Annotation::Reference object
\& Args    : a hash with optional title, authors, location, medline, pubmed,
\&           start, end, consortium, rp and rg attributes
.Ve
.SH "AnnotationI implementing functions"
.IX Header "AnnotationI implementing functions"
.SS "as_text"
.IX Subsection "as_text"
.Vb 6
\& Title   : as_text
\& Usage   :
\& Function:
\& Example :
\& Returns :
\& Args    :
.Ve
.SS "display_text"
.IX Subsection "display_text"
.Vb 4
\& Title   : display_text
\& Usage   : my $str = $ann\->display_text();
\& Function: returns a string. Unlike as_text(), this method returns a string
\&           formatted as would be expected for te specific implementation.
\&
\&           One can pass a callback as an argument which allows custom text
\&           generation; the callback is passed the current instance and any text
\&           returned
\& Example :
\& Returns : a string
\& Args    : [optional] callback
.Ve
.SS "hash_tree"
.IX Subsection "hash_tree"
.Vb 6
\& Title   : hash_tree
\& Usage   :
\& Function:
\& Example :
\& Returns :
\& Args    :
.Ve
.SS "tagname"
.IX Subsection "tagname"
.Vb 3
\& Title   : tagname
\& Usage   : $obj\->tagname($newval)
\& Function: Get/set the tagname for this annotation value.
\&
\&           Setting this is optional. If set, it obviates the need to provide
\&           a tag to Bio::AnnotationCollectionI when adding this object. When
\&           obtaining an AnnotationI object from the collection, the collection
\&           will set the value to the tag under which it was stored unless the
\&           object has a tag stored already.
\& Example :
\& Returns : value of tagname (a scalar)
\& Args    : new value (a scalar, optional)
.Ve
.SH "Specific accessors for References"
.IX Header "Specific accessors for References"
.SS "start"
.IX Subsection "start"
.Vb 6
\& Title   : start
\& Usage   : $self\->start($newval)
\& Function: Gives the reference start base
\& Example :
\& Returns : value of start
\& Args    : newvalue (optional)
.Ve
.SS "end"
.IX Subsection "end"
.Vb 6
\& Title   : end
\& Usage   : $self\->end($newval)
\& Function: Gives the reference end base
\& Example :
\& Returns : value of end
\& Args    : newvalue (optional)
.Ve
.SS "rp"
.IX Subsection "rp"
.Vb 6
\& Title   : rp
\& Usage   : $self\->rp($newval)
\& Function: Gives the RP line. No attempt is made to parse this line.
\& Example :
\& Returns : value of rp
\& Args    : newvalue (optional)
.Ve
.SS "rg"
.IX Subsection "rg"
.Vb 6
\& Title   : rg
\& Usage   : $obj\->rg($newval)
\& Function: Gives the RG line. This is Swissprot/Uniprot specific, and
\&           if set will usually be identical to the authors attribute,
\&           but the swissprot manual does allow both RG and RA (author)
\&           to be present for the same reference.
\&
\& Example :
\& Returns : value of rg (a scalar)
\& Args    : on set, new value (a scalar or undef, optional)
.Ve
.SS "authors"
.IX Subsection "authors"
.Vb 6
\& Title   : authors
\& Usage   : $self\->authors($newval)
\& Function: Gives the author line. No attempt is made to parse the author line
\& Example :
\& Returns : value of authors
\& Args    : newvalue (optional)
.Ve
.SS "location"
.IX Subsection "location"
.Vb 6
\& Title   : location
\& Usage   : $self\->location($newval)
\& Function: Gives the location line. No attempt is made to parse the location line
\& Example :
\& Returns : value of location
\& Args    : newvalue (optional)
.Ve
.SS "title"
.IX Subsection "title"
.Vb 6
\& Title   : title
\& Usage   : $self\->title($newval)
\& Function: Gives the title line (if exists)
\& Example :
\& Returns : value of title
\& Args    : newvalue (optional)
.Ve
.SS "medline"
.IX Subsection "medline"
.Vb 6
\& Title   : medline
\& Usage   : $self\->medline($newval)
\& Function: Gives the medline number
\& Example :
\& Returns : value of medline
\& Args    : newvalue (optional)
.Ve
.SS "pubmed"
.IX Subsection "pubmed"
.Vb 7
\& Title   : pubmed
\& Usage   : $refobj\->pubmed($newval)
\& Function: Get/Set the PubMed number, if it is different from the MedLine
\&           number.
\& Example :
\& Returns : value of medline
\& Args    : newvalue (optional)
.Ve
.SS "database"
.IX Subsection "database"
.Vb 8
\& Title   : database
\& Usage   :
\& Function: Overrides DBLink database to be hard coded to \*(AqMEDLINE\*(Aq (or \*(AqPUBMED\*(Aq
\&           if only pubmed id has been supplied), unless the database has been
\&           set explicitly before.
\& Example :
\& Returns :
\& Args    :
.Ve
.SS "primary_id"
.IX Subsection "primary_id"
.Vb 7
\& Title   : primary_id
\& Usage   :
\& Function: Overrides DBLink primary_id to provide medline number, or pubmed
\&           number if only that has been defined
\& Example :
\& Returns :
\& Args    :
.Ve
.SS "optional_id"
.IX Subsection "optional_id"
.Vb 6
\& Title   : optional_id
\& Usage   :
\& Function: Overrides DBLink optional_id to provide the PubMed number.
\& Example :
\& Returns :
\& Args    :
.Ve
.SS "publisher"
.IX Subsection "publisher"
.Vb 6
\& Title   : publisher
\& Usage   : $self\->publisher($newval)
\& Function: Gives the publisher line. No attempt is made to parse the publisher line
\& Example :
\& Returns : value of publisher
\& Args    : newvalue (optional)
.Ve
.SS "editors"
.IX Subsection "editors"
.Vb 6
\& Title   : editors
\& Usage   : $self\->editors($newval)
\& Function: Gives the editors line. No attempt is made to parse the editors line
\& Example :
\& Returns : value of editors
\& Args    : newvalue (optional)
.Ve
.SS "encoded_ref"
.IX Subsection "encoded_ref"
.Vb 8
\& Title   : encoded_ref
\& Usage   : $self\->encoded_ref($newval)
\& Function: Gives the encoded_ref line. No attempt is made to parse the encoded_ref line
\&    (this is added for reading PDB records (REFN record), where this contains
\&     ISBN/ISSN/ASTM code)
\& Example :
\& Returns : value of encoded_ref
\& Args    : newvalue (optional)
.Ve
.SS "doi"
.IX Subsection "doi"
.Vb 5
\& Title   : doi
\& Usage   : $self\->doi($newval)
\& Function: Gives the DOI (Digital Object Identifier) from the International
\&           DOI Foundation (http://www.doi.org/), which can be used to resolve
\&                   URL links for the full\-text documents using:
\&
\&                   http://dx.doi.org/<doi>
\&
\& Example :
\& Returns : value of doi
\& Args    : newvalue (optional)
.Ve
.SS "consortium"
.IX Subsection "consortium"
.Vb 6
\& Title   : consortium
\& Usage   : $self\->consortium($newval)
\& Function: Gives the consortium line. No attempt is made to parse the consortium line
\& Example :
\& Returns : value of consortium
\& Args    : newvalue (optional)
.Ve
.SS "gb_reference"
.IX Subsection "gb_reference"
.Vb 11
\& Title   : gb_reference
\& Usage   : $obj\->gb_reference($newval)
\& Function: Gives the generic GenBank REFERENCE line. This is GenBank\-specific.
\&           If set, this includes everything on the reference line except
\&                   the REFERENCE tag and the reference count.  This is mainly a
\&                   fallback for the few instances when REFERENCE lines have unusual
\&                   additional information such as split sequence locations, feature
\&                   references, etc.  See Bug 2020 in Bugzilla for more information.
\& Example :
\& Returns : value of gb_reference (a scalar)
\& Args    : on set, new value (a scalar or undef, optional)
.Ve