# The R script xegaGpGene.R

The directory xegaGpGene contains the implementation 
of the functions of the gene layer of with derivation trees
of a context free grammar as genes for  
a genetic algorithm. 

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

1. Linux:
Start R in the directory where you have stored xegaGpGene_0.0.1.0.tar.gz

> install.packages("xegaGpGene_0.0.1.0.tar.gz")

1. Windows:
Start R in the directory where you have stored xegaGpGene_0.0.1.0.zip

> install.packages("xegaGpGene_0.0.1.0.zip")

The R script xegaGpGene.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 xegaGpGene.R:

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

    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("xegaGpGene.R")

Note that the package xegaGpGene provides the functions
of the gene layer of derivation-tree coded genes
the genetic algorithm sga of the family sgX.

Use the pdf-Manual! 

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

Rscript xegaGpGene.R

Restart R and

library(xegaGpGene)

You get all elements of the package by

xegaGpGene::

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.