blib/man3/Reference::Retrieve::PubMed.3pm

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "Reference::Retrieve::PubMed 3pm"
 127 .TH Reference::Retrieve::PubMed 3pm "2013-09-10" "perl v5.14.2" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 Reference::Retrieve::PubMed \-\- Reference Retrieval from PubMed
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 2
 137 \&     my $reference = Reference::Retrieve::PubMed::get_reference(\-pmid=>123456);
 138 \&     my @references = Reference::Retrieve::PubMed::get_reference(\-query=>\*(AqJohn Smith[AUTHOR] AND 230[Pages]\*(Aq,limit=>50);
 139 .Ve
 140 .SH "DESCRIPTION"
 141 .IX Header "DESCRIPTION"
 142 Uh. Retreives references from pubmed. Yeah.
 143 .SH "BUGS"
 144 .IX Header "BUGS"
 145 None known.
 146 .SS "get_reference"
 147 .IX Subsection "get_reference"
 148 \fIUsage\fR
 149 .IX Subsection "Usage"
 150 .PP
 151 .Vb 3
 152 \&     my $reference = Reference::Retrieve::PubMed::get_reference(\-pmid=>123456);
 153 \&     my @references = Reference::Retrieve::PubMed::get_reference(\-query=>\*(AqJohn Smith[AUTHOR] AND 230[Pages]\*(Aq,\-limit=>50);
 154 \&     my @references = Reference::Retrieve::PubMed::get_reference(\-query=>{author=>\*(AqJohn Smith\*(Aq, pages=>\*(Aq230\*(Aq},\-limit=>50)
 155 .Ve
 156 .PP
 157 \fIFunction\fR
 158 .IX Subsection "Function"
 159 .PP
 160 Retrives a reference from pubmed
 161 .PP
 162 \fIReturns\fR
 163 .IX Subsection "Returns"
 164 .PP
 165 In scalar context, effectively assumes \-limit=>1 and returns the
 166 highest listed reference according to the order, etc. [Probably only
 167 usefull with \-pmid.] In list context, returns all results (or until it
 168 hits the \-limit.)
 169 .PP
 170 \fIArgs\fR
 171 .IX Subsection "Args"
 172 .PP
 173 list of arguments to select a reference or collection of references from.
 174 .SS "_fix_medline_journal"
 175 .IX Subsection "_fix_medline_journal"
 176 \fIUsage\fR
 177 .IX Subsection "Usage"
 178 .PP
 179 .Vb 3
 180 \&     $reference\->journal(_fix_medline_journal($ref\->{MedlineCitation}\->{Article}\->{Journal},
 181 \&                                              $ref\->{MedlineCitation}\->{Article}\->{MedlineJournalInfo},
 182 \&                                              $ua,));
 183 .Ve
 184 .PP
 185 \fIFunction\fR
 186 .IX Subsection "Function"
 187 .PP
 188 From the medline citation informatino returns a properly formatted
 189 list of information for the journal reference listing.
 190 .PP
 191 \fIArgs\fR
 192 .IX Subsection "Args"
 193 .PP
 194 Journal information hashref
 195 .PP
 196 medline journal information hashref
 197 .PP
 198 user agent
 199 .SS ""
 200 .IX Subsection ""
 201 \fIUsage\fR
 202 .IX Subsection "Usage"
 203 .PP
 204 .Vb 1
 205 \&     $reference\->date(_fix_medline_pubdate($ref\->{MedlineCitation}\->{Article}\->{Journal}\->{JournalIssue}\->{PubDate}));
 206 .Ve
 207 .PP
 208 \fIFunction\fR
 209 .IX Subsection "Function"
 210 .PP
 211 \fIReturns\fR
 212 .IX Subsection "Returns"
 213 .PP
 214 \fIArgs\fR
 215 .IX Subsection "Args"
 216 .SS "_fix_medline_pages"
 217 .IX Subsection "_fix_medline_pages"
 218 \fIUsage\fR
 219 .IX Subsection "Usage"
 220 .PP
 221 .Vb 1
 222 \&     pages      => [_fix_medline_pages($ref\->{MedlineCitation}\->{Article}\->{Pagination}\->{MedlinePgn})],
 223 .Ve
 224 .PP
 225 \fIFunction\fR
 226 .IX Subsection "Function"
 227 .PP
 228 Returns output with a list of pages appropriate for an Article type of
 229 reference.
 230 .SS "_fix_ids"
 231 .IX Subsection "_fix_ids"
 232 .Vb 1
 233 \&     _fix_ids
 234 .Ve
 235 .SS "_find_links_from_url"
 236 .IX Subsection "_find_links_from_url"
 237 \fIUsage\fR
 238 .IX Subsection "Usage"
 239 .PP
 240 \fIFunction\fR
 241 .IX Subsection "Function"
 242 .PP
 243 \fIReturns\fR
 244 .IX Subsection "Returns"
 245 .PP
 246 \fIArgs\fR
 247 .IX Subsection "Args"