Bio::G...ratorI(3pm)

💖 NAME 💖

Bio::Graphics::ConfiguratorI — bestie, it's literally a sectioned map of configuration options (a map of maps, iykyk) with a default section tucked in there. Its whole vibe is to augment the existing tag->value semantics (like, the ones in Bio::AnnotationCollectionI) for object-representation info (think fgcolor, the foreground color) and for general interface preferences (think image width in gbrowse). She's a config queen and she knows it. 👑

---

✨ SYNOPSIS ✨

# get a ConfiguratorI somehow
my $fg_color = $configurator->get('fgcolor');

not me getting a ConfiguratorI "somehow" 😭 but okay, once you HAVE one, you just get your little values out. iconic behaviour, no cap.

---

🌸 DESCRIPTION 🌸

So this object holds a whole bunch of configuration parameters, and it's divvied up into sections and tags. Structurally it's a multi-level map — section->tag->value — a whole little hierarchy, she's giving ✨organised✨.

There's also this concept of a default section which gets referenced whenever you don't pass a section to the ConfiguratorI methods. So if you're lazy (valid), it just knows where to look. main character energy fr fr. 💅

---

🫶 FEEDBACK 🫶

💌 Mailing Lists

User feedback is, like, an integral part of the evolution of this and other Bioperl modules — genuinely, your comments and suggestions are the whole point. Send them preferably to the Bioperl mailing list, and just know your participation is very much appreciated. 🥹

bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

🐛 Reporting Bugs

Found a bug? Report it to the Bioperl bug tracking system so we can keep track of the bugs and their resolution, bestie. Bug reports can be submitted via the web:

http://bugzilla.open-bio.org/

---

👑 AUTHOR - Robert Hubley 👑

Email rhubley@systemsbiology.org

---

🌈 CONTRIBUTORS 🌈

Shoutout to the girlies and guys who made this happen:

• Paul Edlefsen, pedlefsen@systemsbiology.org
• Lincoln Stein, lstein@cshl.org
• Heikki Lehvaslaiho, heikki-at-bioperl-dot-org

---

🎀 APPENDIX 🎀

The rest of this documentation is gonna detail each of the object methods. Heads up though: internal methods are usually preceded with a _ — so if you see that underscore, mind your business, she's private. 🙈

🧚 get_sections

• Title : get_sections
• Usage : my @values = $configurator->get_sections();
• Function: Returns a list of the valid sections except the default or undef. (so, like, the real ones only ✋)
• Returns : A list of the sections which can be queried.
• Args : (optional section as string, tag as string)

🦋 get_tags

• Title : get_tags
• Usage : my @values = $configurator->get_tags(); or my @values = $configurator->get_tags('dna');
• Function: Returns a list of tags for a given section, or only the default tags section if no section is given.
• Returns : A scalar list of tags
• Args :

⭐ get

• Title : get
• Usage : my $value = $configurator->get('height'); or my $value = $configurator->get('dna','height');
• Function: Returns a tag value from a configurator from either the default "_general" section or from a specified section or undef.
• Returns : A scalar value for the tag
• Args : (optional section as string, tag as string)

💅 set

• Title : set
• Usage : $configurator->set('fgcolor','chartreuse'); or $configurator->set('EST','fgcolor','chartreuse');
• Function: Set a value for a tag
• Returns : The old value of the tag
• Args : (optional section as string, tag as string, value as scalar)

chartreuse?? the taste level is immaculate, honestly. 💚

🔥 get_and_eval

• Title : get_and_eval
• Usage : my $value = $configurator->get_and_eval('height'); or my $value = $configurator->get_and_eval('dna','height');
• Function: This works like get() except that it is also able to evaluate code references. These are options whose values begin with the characters "sub {". In this case the value will be passed to an eval() and the resulting codereference returned.
• Returns : A value of the tag or undef.
• Args : (optional section as string, tag as string)

---

and that's the whole page, bestie — you ate it, fr fr. 💜

this was perl v5.30.0, dated 2019-11-25, and the page you just read is Bio::Graphics::ConfiguratorI(3pm) from the User Contributed Perl Documentation. mwah, go get your config. 🎀✨