CracTools::Config - Manage and access CracTools configuration file
version 1.251
use CracTools::Config; # Open the configuration file CracTools::Config::LoadConfig($config_file); # Retrieve some variable $gff_file = CracTools::Config::getConfVar('ANNOTATION_GFF');
This module aims to integrate a common configuration file among all the cractools pipelines. It automatically load the configuration file by looking to diverse locations, then it provides methods to retrieved the variables declared in the configuration file.
The configuration file name is CracTools.cfg, and the space search is the current director, the home dir, local configurations (/usr/loacl/etc) and default configurations (/etc/).
CracTools.cfg
This module is based on Config::FileManager.
Example : CracTools::Config::PrintVersion(); Description : Print (in an uniformized way) the version information of the CracTool script. ReturnType : undef
Example : my $default_cfg = LoadConfig(); # Use (and get) default config file (see L<Config::FileManager>) LoadConfig("your_file.conf"); Description : Load the default configuration file. ReturnType : undef
Arg [1] : String - variable name Example : my $var = getConfVar("GENOME"); Description : Return the variable value found in the configuration file ReturnType : String
Nicolas PHILIPPE <nphilippe.research@gmail.com>
Jérôme AUDOUX <jaudoux@cpan.org>
Sacha BEAUMEUNIER <sacha.beaumeunier@gmail.com>
This software is Copyright (c) 2017 by IRMB/INSERM (Institute for Regenerative Medecine and Biotherapy / Institut National de la Santé et de la Recherche Médicale) and AxLR/SATT (Lanquedoc Roussilon / Societe d'Acceleration de Transfert de Technologie).
This is free software, licensed under:
The GNU Affero General Public License, Version 3, November 2007
To install CracTools, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CracTools
CPAN shell
perl -MCPAN -e shell install CracTools
For more information on module installation, please visit the detailed CPAN module installation guide.