GBrows...figData(3pm)

💖 NAME 💖

GBrowse::ConfigData — bestie, it's the configuration for the GBrowse module 💅

So like, this is GBrowse::ConfigData(3pm) from the User Contributed Perl Documentation, and it's literally the little vault where all of GBrowse's config lives. ✨

---

🌸 SYNOPSIS 🌸

okay so here's the whole vibe, no cap:

use GBrowse::ConfigData;
$value = GBrowse::ConfigData->config('foo');
$value = GBrowse::ConfigData->feature('bar');

@names = GBrowse::ConfigData->config_names;
@names = GBrowse::ConfigData->feature_names;

GBrowse::ConfigData->set_config(foo => $new_value);
GBrowse::ConfigData->set_feature(bar => $new_value);
GBrowse::ConfigData->write;  # Save changes

get it, set it, save it, slay. 🫶

---

🦋 DESCRIPTION 🦋

This module holds the configuration data for the GBrowse module. It also provides a programmatic interface for getting or setting that configuration data.

⚠️ but like, real talk bestie — to actually make changes you have to have write access to the GBrowse::ConfigData module, and you should attempt to understand the repercussions of your actions. that's the original's words and honestly? they're giving ominous older-sibling energy. 😭

---

👑 METHODS 👑

config($name)

Give it a string argument and it returns the value of the configuration item with that name. If no such item exists, you get undef. 💀

feature($name)

Give it a string argument and it returns the value of the feature with that name. No such feature? undef, sorry babe. 🙈

set_config($name, $value)

Sets the configuration item with the given name to the given value. The value can be any Perl scalar that will serialize correctly using Data::Dumper. That includes references, objects (usually), and complex data structures. It probably does not include transient things like filehandles or sockets. ✋ so don't even try it with a socket, it's not gonna go how you think.

set_feature($name, $value)

Sets the feature with the given name to the given boolean value. The value gets converted to 0 or 1 automatically — it's giving binary, it's giving boolean, it's giving decided. 💅

config_names()

Returns a list of all the names of config items currently defined in GBrowse::ConfigData — or, in scalar context, the number of items. 🔢

feature_names()

Returns a list of all the names of features currently defined in GBrowse::ConfigData — or, in scalar context, the number of features. 🔢

auto_feature_names()

Returns a list of all the names of features whose availability is dynamically determined — or, in scalar context, the number of such features.

🚨 important caveat: this does not include such features that have later been set to a fixed value. once you pin it down, it's out of the auto list. periodt.

write()

Commits any changes from set_config() and set_feature() to disk. Requires write access to the GBrowse::ConfigData module. this is the "hit save" button of the whole operation, bestie. 🔥

---

🎀 AUTHOR 🎀

GBrowse::ConfigData was automatically created using Module::Build. Module::Build was written by Ken Williams, but he holds no authorship claim or copyright claim to the contents of GBrowse::ConfigData.

so like, the scaffolding is his, the contents are not — got it? iconic of him honestly. 👑

---

and that's the whole page, bestie 🦋✨ this was perl v5.40.0, dated 2024-10-20, and you read it in GBrowse::ConfigData(3pm). mwah, go forth and configure responsibly 💖💅