# The R script xegaBNF.R

The directory xegaBNF contains the implementation 
of the grammar compiler which translates a file 
with the BNF of a grammar into the internal
representation of the grammar.

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

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

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

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



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

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

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

Note that the package xegaBNF provides the functions
of the grammar compiler needed 
for the option "sgp" of the algorithm sga of the family sgX.

Use the pdf-Manual! 

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

Rscript xegaBNF.R

Restart R and

library(xegaBNF)

You get all elements of the package by

xegaBNF::

and pressing the tabulator.

You get the man page by e.g 

?booleanGrammar()

or 

help(booleanGrammar)

All examples given on a man page can be executed by

example(booleanGrammar)

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