NAME¶
Bio::Tools::Run::GenericParameters - An object for the parameters used to run
programs
SYNOPSIS¶
my $void = $obj->set_parameter("parameter_name","parameter_value");
my $value = $obj->get_parameter("parameter_name");
DESCRIPTION¶
This is a basic container to hold the parameters used to run a program. This
module may get incorporated into the more generic Bio::Tools::Run framework in
bioperl-run distribution.
FEEDBACK¶
Mailing Lists¶
User feedback is an integral part of the evolution of this and other Bioperl
modules. Send your comments and suggestions preferably to the Bioperl mailing
list. Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Support¶
Please direct usage questions or support issues to the mailing list:
bioperl-l@bioperl.org
rather than to the module maintainer directly. Many experienced and reponsive
experts will be able look at the problem and quickly address it. Please
include a thorough description of the problem with code and data examples if
at all possible.
Reporting Bugs¶
Report bugs to the Bioperl bug tracking system to help us keep track of the bugs
and their resolution. Bug reports can be submitted via the web:
https://github.com/bioperl/bioperl-live/issues
AUTHOR - Chad Matsalla¶
Email bioinformatics1 at dieselwurks dot com
CONTRIBUTORS¶
Sendu Bala, bix@sendu.me.uk
APPENDIX¶
The rest of the documentation details each of the object methods. Internal
methods are usually preceded with a _
get_parameter¶
Title : get_parameter
Usage : $parameter_object->get_parameter($param_name);
Function: Get the value of a parameter named $param_name
Returns : A scalar that should be a string
Args : A scalar that should be a string
set_parameter¶
Title : set_parameter
Usage : $parameter_object->set_parameter($param_name => $param_value);
Function: Set the value of a parameter named $param_name to $param_value
Returns : Void
Args : A hash containing name=>value pairs
available_parameters¶
Title : available_parameters
Usage : my @paramnames = $parameter_object->available_parameters
Function: Returns the names of the available parameters
Returns : list of available parameter names
Args : none