README.Rmd

---
output:
  md_document:
    variant: markdown_github
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

# leabRa

This package provides the Leabra artificial neural network algorithm (O’Reilly, 1996) for R. Leabra stands for “local error driven and associative biologically realistic algorithm”. It is the Rolls Royce of artificial neural networks because it combines error driven learning and self organized learning in an elegant way, while focusing on a biologically plausible learning rule. If you have never heard of Leabra, you should read about it first. A good place to start is the computational cognitive neuroscience book (Part I), available at https://grey.colorado.edu/CompCogNeuro/index.php/CCNBook/Main (O’Reilly et al., 2016).

## Installation
<!--via CRAN: 

```{r}
#install.pacakges("leabRa")
```
-->
via devtools and git (and with building the vignette; this takes a while)
```{r, eval=FALSE, message=FALSE, warning=FALSE}
install.packages("devtools")
devtools::install_github("johannes-titz/leabRa", build_vignettes = TRUE)
``` 

Now you can load the package:

```{r}
library(leabRa)
```

To see how it works, have a look at the vignette:
```{r, message=FALSE, warning=FALSE}
vignette("leabRa")
```

And the help files:
```{r}
?network
?layer
?unit
```

## Citation
Johannes Titz (2017). *leabRa: An R implementation of the artificial neural networks algorithm Leabra*. R
  package version 0.1.0. https://CRAN.R-project.org/package=leabRa