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

Update readme file

parent 66747d6e
...@@ -5,33 +5,38 @@ functions to estimate drift and diffusion functions from time series and ...@@ -5,33 +5,38 @@ functions to estimate drift and diffusion functions from time series and
generate synthetic time series from given drift and diffusion coefficients. generate synthetic time series from given drift and diffusion coefficients.
### Documentation ### 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
'citation("Langevin")' for details.
To cite the Langevin package and/or the mathematical concept behind it correctly
see 'citation("Langevin")' for details.
### Examples ### Examples
The help files for each function contain usage examples, additionally the The help files for each function contain usage examples, additionally the
package repository ships a package repository ships a
[script](https://gitlab.uni-oldenburg.de/TWiSt/Langevin/raw/master/examples.r) [script](https://gitlab.uni-oldenburg.de/TWiSt/Langevin/raw/master/examples.r)
with examples that reproduce the figures from the vignette. with examples that reproduce the figures from the vignette.
### Installation ### Installation
Released and tested versions of the Langevin package are available at Released and tested versions of the Langevin package are available at
[CRAN](http://cran.r-project.org) and can be installed from within R via [CRAN](http://cran.r-project.org) and can be installed from within R via
```R ```R
install.packages("Langevin") 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 ```R
install.packages("devtools") install.packages("devtools")
...@@ -39,6 +44,7 @@ library("devtools") ...@@ -39,6 +44,7 @@ library("devtools")
install_git("https://gitlab.uni-oldenburg.de/TWiSt/Langevin.git") install_git("https://gitlab.uni-oldenburg.de/TWiSt/Langevin.git")
``` ```
### Authors ### Authors
Philip Rinn, Pedro G. Lind and David Bastine 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