# The R script xegaDfGene.R

The directory xegaDfGene contains the implementation 
of the functions of the gene layer of real coded genes of 
a genetic algorithm. 


The easiest installation is by using install.packages from R.

1. Linux:
Start R in the directory where you have stored xegaDfGene_0.0.0.1.tar.gz

> install.packages("xegaDfGene_0.0.0.1.tar.gz")

1. Windows:
Start R in the directory where you have stored xegaDfGene.0.0.1.zip

> install.packages("xegaDfGene_0.0.0.1.zip")

The R script xegaDfGene.R generates

1. the man pages of the package.
2. the pdf documentation of the package.
3. the compilation and installation of the package.
   (You  must adapt the variables path and pName
    in the script xegaDfGene.R:

    path<-"~/dev/iaa/genetic/xega/"
    pName<-"xegaDfGene"

    to the directory where you copy the package.

You need to install the R-package devtools for this R script.

There are two ways to use the code:

1. Change into the R directory which contains the code, start R and load all code files:

source("xegaDfGene.R")

Note that the package xegaDfGene provides the functions
of the gene layer of real coded genes
of the genetic algorithm sgde of the family sgX.

Use the pdf-Manual! 

2. Adapt the path in xegaDfGene.R and install the library xegaDfGene:

Rscript xegaDfGene.R

Restart R and

library(xegaDfGene)

You get all elements of the package by

xegaDfGene::

and pressing the tabulator.

You get the man page by e.g 

?InitGene

or 

help(InitGene)

All examples given on a man page can be executed by

example(InitGene)

Note that man pages and examples are only available, if you install 
the package as a library.