.\" 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 "GO::Metadata::Panther 3pm" .TH GO::Metadata::Panther 3pm "2021-01-09" "perl v5.32.0" "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" GO::Metadata::Panther \- Species info for data used by Panther Clusters .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use GO::Metadata::Panther; \& my $s = GO::Metadata::Panther\->code(\*(AqYEAST\*(Aq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Inherits functions from GO::Metadata::UniProt::Species. .PP Accesses information related to species in the Panther \fIseq2pthr.gz\fR file. This file can be fetched from: .SS "Exportable Subroutines" .IX Subsection "Exportable Subroutines" .IP "\fBpanther_codes()\fR" 4 .IX Item "panther_codes()" Returns the list of UniProt species codes that are used in Panther clusters. .IP "GO::Metadata::Panther\->\fBpanther_all()\fR" 4 .IX Item "GO::Metadata::Panther->panther_all()" Returns a list of \f(CW\*(C`GO::Metadata::Panther\*(C'\fR objects that are used in Panther clusters. .IP "valid_codes(...)" 4 .IX Item "valid_codes(...)" Returns a true value in every argument is a UniProt species code used in Panther cluster. Otherwise returns false. .SS "\s-1OO\s0 Function" .IX Subsection "OO Function" .IP "GO::Metadata::Panther\->new(...);" 4 .IX Item "GO::Metadata::Panther->new(...);" This basically hands things off to GO::Metadata::UniProt::Species's new function. Populates that with other Panther/GO specific information, and does some error correction. .ie n .IP "$s\->\fBncbi_taxa_ids()\fR" 4 .el .IP "\f(CW$s\fR\->\fBncbi_taxa_ids()\fR" 4 .IX Item "$s->ncbi_taxa_ids()" Returns the list of \s-1NCBI\s0 taxa identifiers associated with the UniProt species code. In a perfect word this will only every return one value. In any case, the first value will be the actual numeric identifier associated. .ie n .IP "$s\->\fBprefers()\fR" 4 .el .IP "\f(CW$s\fR\->\fBprefers()\fR" 4 .IX Item "$s->prefers()" Returns a list of id types (generally to be populated in \&\f(CW\*(C`dbxref.xref_dbname\*(C'\fR) in order of preference of use. If a null list, we have never encountered a conflict that needed resolving. .SS "\s-1SEE ALSO\s0" .IX Subsection "SEE ALSO" GO::Metadata::UniProt::Species .SS "\s-1AUTHOR\s0" .IX Subsection "AUTHOR" Sven Heinicke