README

   1 INSTALLATION
   2
   3 Prerequisites
   4
   5 Function2Gene requires the following modules and programs to work
   6 properly:
   7
   8   * perl
   9   * wget
  10   * HTML::TreeBuilder
  11   * HTML::ElementTable
  12   * XML::Parser
  13
  14 The operating system-specific instructions below will help you to
  15 install these modules.
  16
  17 Unix instructions
  18
  19 If you're running a reasonably modern Linux (or other UNIX variant,
  20 like MacOS X) you already have perl and wget. If so, you can install
  21 the remaining modules by doing the following:
  22
  23  cpan install HTML::TreeBuilder
  24  cpan install HTML::Element::Extended
  25  cpan install XML::Parser
  26
  27 If you are running Debian, you can just run the following:
  28
  29  aptitude install wget perl libhtml-element-extended-perl libxml-parser-perl
  30
  31 Windows
  32
  33 If you are using a windows-based machine, first consider switching to (or
  34 dual-booting) Debian or Ubuntu or a similar Free Software distribution. If
  35 switching isn't for you, you will need to install cygwin (a linux-like
  36 environment for windows), which (by default) will install perl and wget.
  37
  38 You can then use the cpan commands listed above to install the required
  39 modules:
  40
  41  cpan install HTML::TreeBuilder
  42  cpan install HTML::Element::Extended
  43  cpan install XML::Parser
  44
  45 Other Operating Systems
  46
  47 If you are using another operating system (minux, MacOS 9, UNIVAX, Plan9,
  48 OS/2, etc.) you're on your own.
  49
  50
  51 USAGE
  52
  53 All of the programs are located within a bin directory. For a
  54 demonstration, you can simply do the following:
  55
  56 cd bin;
  57 echo 'transferrin' > keywords.txt
  58 function2gene --keywords keywords.txt --results keyword_results;
  59