Current State

Please note that this software is under development. Some things might not work as intended right now. We are looking forward to push our first release candidate (version 1.0) in the first half of 2019, together with an implementation in python (see below).

If there are any questions please do not hesitate to contact me (via github).

All best,

Reto, Matthias, Georg, and Fabien.

Documentation

The R package foehnix is still under development and so is the documentation of the package. However, if you would like to get some more details and examples please visit our latest documentation on:

• http://retostauffer.github.io/Rfoehnix

Python Version of the foehnix Package

The foehnix package was develoed for both, the statistical programming language R and python. The python package can be found here:

• foehnix for python

Installation

foehnix can be installed using the R package githubinstall (or devtools, or simply clone and install locally).

Using 'devtools'

Via https (devtools::install_github)

Currently the package is only available via github. One convenient way to install packages from github is is via devtools (requires R package devtools to be installed; if not use install.packages("devtools")).

The following snippet installes the latest development version of the foehnix package from github.com/retostauffer/Rfoehnix:

# Load devtools
library("devtools")

# Install package, should also resolve the dependencies
install_github("retostauffer/Rfoehnix")

Note: If you do not like experimental versions feel free to install one of our release candidates, e.g., v0.0-2, an early alpha release from December 2018. To install a release candidate provide the additional ref argument. A list of available release candidates can be found on the github release page.

# Load devtools
library("devtools")

# Install package, should also resolve the dependencies
devtools::install_github("retostauffer/Rfoehnix", ref = "v0.0-2")

By cloning the repository

You can also clone the repository and install the package based on the checkout. For linux users:

# Change directory
cd <somewhere/on/your/local/disc>

# Clone repository
git clone https://github.com/retostauffer/Rfoehnix.git

# Start R
R

As soon as you are in the interactive R shell:

# Loading the devtools library
library("devtools")

# Install package
devtools::install("Rfoehnix")

For Command Shell Fans

Fans of the good old console can of course use the good old way.

# Change directory
cd <somewhere/on/your/local/disc>

# Clone repository
git clone https://github.com/retostauffer/Rfoehnix.git

# Feel free to use on of our release candidates which
# might miss some features, but might also be more stable.
# A list of release candidates can be found on:
# - https://github.com/retostauffer/Rfoehnix/releases
(cd Rfoehnix && git checkout tags/<tagname> && cd ..)

# Install directly
R CMD INSTALL Rfoehnix

# OR
R CMD build Rfoehnix
R CMD INSTALL foehnix_<version>.tar.gz