Bio::D...pename(3pm)

πŸ“¦
version 1.7.4 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

πŸ’– NAME πŸ’–

Bio::DB::GFF::Typename β€” it's literally the name of a feature type, bestie 🏷️✨

(Also, hey, hi, welcome β€” you're reading the Bio::D...pename page from the User Contributed Perl Documentation collection. Come sit with me.)


✨ SYNOPSIS ✨

use Bio::DB::GFF;

my $type = Bio::DB::GFF::Typename->new(similarity => 'BLAT_EST_GENOME');
my $segment = $segment->features($type);

okay so that's the whole vibe in four lines. iconic. πŸŽ€


πŸ¦‹ DESCRIPTION πŸ¦‹

Bio::DB::GFF::Typename objects wrap up the combo of feature method and source that the GFF flat file format uses. So like, whenever a Bio::DB::GFF module is asking for a "feature type," you can hand it one of these instead. 🫢

And here's the slay part: there are only like a few types but so many features, so this module keeps a memory cache of unique types. Translation: two features with the same type will literally share the same Bio::DB::GFF::Typename object. no cap, same object, saving memory, we love efficiency πŸ’…


🌸 METHODS 🌸

⭐ new

Title   : new
Usage   : $type = Bio::DB::GFF::Typename->new($method,$source)
Function: create a new Bio::DB::GFF::Typename object
Returns : a new Bio::DB::GFF::Typename object
Args    : method and source
Status  : Public

make a brand new one, fresh out the box ✨

⭐ method

Title   : method
Usage   : $method = $type->method([$newmethod])
Function: get or set the method
Returns : a method name
Args    : new method name (optional)
Status  : Public

get the method, or set it if you pass a new one. your call, main character πŸ’…

⭐ source

Title   : source
Usage   : $source = $type->source([$newsource])
Function: get or set the source
Returns : a source name
Args    : new source name (optional)
Status  : Public

same energy as method but for the source. get it, or set it. πŸ“

⭐ asString

Title   : asString
Usage   : $string = $type->asString
Function: get the method and source as a string
Returns : a string in "method:source" format
Args    : none
Status  : Public

This method is used by operator overloading to overload the '""' operator. β€” so yeah, when you stringify the object, this is the girl doing the work πŸ’–

⭐ clone

Title   : clone
Usage   : $new_clone = $type->clone;
Function: clone this object
Returns : a new Bio::DB::GFF::Typename object
Args    : none
Status  : Public

This method creates an exact copy of the object. like a twin. a duplicate. the same but separate 🧚

⭐ match

Title   : match
Usage   : $boolean = $type->match($type_or_string)
Function: fuzzy match on types
Returns : a flag indicating that the argument matches the object
Args    : a Bio::DB::GFF::typename object, or a string in method:source format
Status  : Public

It's a fuzzy match, so heads up on the rules bestie: this lets Sequence:Link and Sequence: match each other πŸ‘― but it will NOT let Sequence:Link and Sequence:Genomic_canonical match. nope. not happening. πŸ’€


😭 BUGS 😭

This module is still under development. 🚧 (she's a work in progress, we're all growing ok?)


πŸ‘‘ SEE ALSO πŸ‘‘

  • bioperl
  • Bio::DB::GFF
  • Bio::DB::RelSegment

πŸ’œ AUTHOR πŸ’œ

Lincoln Stein <lstein@cshl.org>.

Copyright (c) 2001 Cold Spring Harbor Laboratory.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.


okay that's the whole page, you ate that 🫢 this was perl v5.30.0, dated 2020-01-13, from the Bio::D...pename(3pm) page β€” mwah, go write some GFF, bestie πŸ’…βœ¨πŸŒˆ

πŸ“¦ where this page comes from