Commit cc6cf5f7 authored by Philip Rinn's avatar Philip Rinn
Browse files

Update readme file

parent 66747d6e
......@@ -7,11 +7,15 @@ generate synthetic time series from given drift and diffusion coefficients.
### Documentation
The package ships a pdf vignette.
All functions of the Langevin package have corresponding help files.
Additionally the package ships a pdf vignette which corresponds to a paper on
[arXiv](http://arxiv.org/pdf/1603.02036).
Additional documentation is available as a paper on
[arXiv](http://arxiv.org/pdf/1603.02036) (corresponding to the vignette) see
'citation("Langevin")' for details.
### Citation
To cite the Langevin package and/or the mathematical concept behind it correctly
see 'citation("Langevin")' for details.
### Examples
......@@ -31,7 +35,8 @@ Released and tested versions of the Langevin package are available at
install.packages("Langevin")
```
The development version of Langevin can be installed from within R via
The development version of the Langevin package can be installed from within R
via
```R
install.packages("devtools")
......@@ -39,6 +44,7 @@ library("devtools")
install_git("https://gitlab.uni-oldenburg.de/TWiSt/Langevin.git")
```
### Authors
Philip Rinn, Pedro G. Lind and David Bastine
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment