Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MLopez-Ibanez committed Aug 7, 2023
1 parent 1fc2c48 commit 5ef7507
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,20 +63,8 @@ visualization.
Download and installation
-------------------------

The software is implemented as an R package, but the code for only computing
the EAF is available as a C program, and it does not require installing R or
any R packages. Just [download the package source
code](https://cran.r-project.org/package=eaf), uncompress it, and look for the
directory `src/eaf`. This code can be used to implement your own visualizations
instead of the visualizations provided by the **eaf** package. Compiled binaries
can be found under `system.file(package="eaf", "bin")`. Other useful
binaries can be found there.

The visualization of the EAFs requires installing the **eaf** package. Therefore,
a basic knowledge of R is recommended to make use of all features. However, the
`eaf` package contains two Perl scripts that allow to generate standard plots
without any R knowledge. See `inst/scripts/eafplot/` and
`inst/scripts/eafdiff/` in the package source code. The scripts use the **eaf** package internally to generate the plots, and, hence, the **eaf** package must be installed and working.
The **eaf** package is implemented in R. Therefore,
a basic knowledge of R is recommended to make use of all features.

The first step before installing the **eaf** package is to [install R](https://cran.r-project.org/). Once R is installed in the system, there are two methods for installing the **eaf** package:

Expand All @@ -97,6 +85,19 @@ The first step before installing the **eaf** package is to [install R](https://c

Search the [R documentation](https://cran.r-project.org/faqs.html) if you need more help to install an R package on your system.

The code for computing the EAF is available as a C program, and it does not require installing R or any R packages. Just [download the package source
code](https://cran.r-project.org/package=eaf), uncompress it, and look for the
directory `src/eaf`. The C code can be used to implement your own visualizations
instead of the visualizations provided by the **eaf** package. Compiled executables for computing the EAF can be found under `system.file(package="eaf", "bin")`. Other useful
executable programs can be found there.

The `eaf` package also contains two Perl scripts that may allow you to generate
standard plots without any R knowledge. See `inst/scripts/eafplot/` and
`inst/scripts/eafdiff/` in the package source code. The scripts use the **eaf**
package internally to generate the plots, and, hence, the **eaf** package must
be installed and working.


If you wish to be notified of bugfixes and new versions, please subscribe to the [low-volume emo-list](https://lists.dei.uc.pt/mailman/listinfo/emo-list), where announcements will be made.

[ [Download **eaf** package from CRAN](https://cran.r-project.org/package=eaf) ] [ [Documentation](https://mlopez-ibanez.github.io/eaf/) ] [ [Development version (GitHub)](https://github.com/MLopez-Ibanez/eaf) ]
Expand Down

0 comments on commit 5ef7507

Please sign in to comment.