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

πŸ“¦
version 3.01 Β· 3 versions
, in debian trixie, ubuntu questing

✨ NAME ✨

Bio::DB::HTS::ConfigData β€” bestie, it's literally the Configuration for Bio::DB::HTS πŸ’–

(yes this page lives in the User Contributed Perl Documentation section, under the manual name Bio::D...igData(3pm) β€” iykyk πŸŽ€)


🌸 SYNOPSIS 🌸

okay so here's the whole vibe, verbatim:

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

@names = Bio::DB::HTS::ConfigData->config_names;
@names = Bio::DB::HTS::ConfigData->feature_names;

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

πŸ¦‹ DESCRIPTION πŸ¦‹

so this module holds the configuration data for the Bio::DB::HTS module. that's the whole job. it also hands you a cute little programmatic interface for getting or setting that configuration data, which is giving very much "look at me, I'm a real API" πŸ’…

⚠️ real talk though: to actually make changes you have to have write access to the Bio::DB::HTS::ConfigData module. and before you go changing stuff, you should lowkey attempt to understand the repercussions of your actions, bestie. this is not a "yolo edit and pray" situation 😭

πŸ‘‘ METHODS πŸ‘‘

πŸ’– config($name)

give it a string argument and it returns the value of the configuration item with that name. or undef if no such item exists. so if it doesn't know her, she returns nothing. ghosted ✨

πŸ’– feature($name)

give it a string argument and it returns the value of the feature by that name, or undef if no such feature exists. same energy, different list 🫢

πŸ’– set_config($name, $value)

sets the configuration item with the given name to the given value. and here's the tea: the value may 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 try it πŸ™ˆ

πŸ’– 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 on/off, no in-between, periodt πŸ’…

πŸ’– config_names()

returns a list of all the names of config items currently defined in Bio::DB::HTS::ConfigData. or, in scalar context, the number of items. list or count, she's flexible like that 🌈

πŸ’– feature_names()

returns a list of all the names of features currently defined in Bio::DB::HTS::ConfigData. or, in scalar context, the number of features. same deal, iconic behavior ⭐

πŸ’– 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. and heads up: it does not include such features that have later been set to a fixed value. once they're locked in, they're off the list, no cap πŸ’€

πŸ’– write()

commits any changes from set_config() and set_feature() to disk. requires write access to the Bio::DB::HTS::ConfigData module. this is the "actually save it" button, bestie β€” nothing sticks without her πŸ”₯


🧚 AUTHOR 🧚

Bio::DB::HTS::ConfigData was automatically created using Module::Build. and Module::Build was written by Ken Williams, but he holds no authorship claim or copyright claim to the contents of Bio::DB::HTS::ConfigData. so like… he built the machine, but the contents? not his, fr fr 🌸


okay that's the whole page bestie, you ate it πŸ’– this was brought to you by perl v5.40.0, dated 2024-10-31, in the Bio::D...igData(3pm) manual β€” mwah, go forth and configure responsibly πŸŽ€βœ¨πŸ¦‹

πŸ“¦ where this page comes from