2019-12-17 11:07:33 +00:00
# Installation Instructions
The package depends on the `mda` package (see: [mda @ cran.r-project ](https://cran.r-project.org/web/packages/mda/index.html ). Therefore the first step is to install the `mda` package
2019-11-20 18:03:21 +00:00
```R
2019-12-17 11:07:33 +00:00
install.packages("mda")
2019-11-20 18:03:21 +00:00
```
2019-12-17 11:07:33 +00:00
A release will be available in a few days.
2019-11-20 18:03:21 +00:00
2020-01-06 10:19:08 +00:00
- Linux: release 1 Version 0.2 [CVE_0.2.tar.gz ](https://git.art-ist.cc/daniel/CVE/releases/download/0.2/CVE_0.2.tar.gz )
- Windows: release 1 Version 0.2 [CVE_0.2.zip ](https://git.art-ist.cc/daniel/CVE/releases/download/0.2/CVE_0.2.zip )
2019-12-17 11:07:33 +00:00
- MacOS: Not available jet (unknown)
2019-11-20 18:03:21 +00:00
2019-12-17 11:07:33 +00:00
Open `R` and then the following:
2019-11-20 18:03:21 +00:00
```R
2019-12-17 11:07:33 +00:00
# addapt to download file.
install.packages("path/to/cve_0.2.< end > ", repos = NULL)
library(CVE) # Test installation.
2019-11-20 18:03:21 +00:00
```
2019-12-17 11:07:33 +00:00
Please consult the man-pages `?install.package` and `?library` for further information.
2019-11-20 18:03:21 +00:00
2019-12-17 11:07:33 +00:00
## Installing Source
Cloning the `CVE` repository and using `R` 's build and install routines from a terminal.
```bash
git clone https://git.art-ist.cc/daniel/CVE.git # Clone repository
cd CVE # Go into the repository
R CMD build CVE # Build package tarbal
R CMD INSTALL CVE_0.2.tar.gz # Install package
2019-11-20 18:03:21 +00:00
```
2020-09-18 16:07:13 +00:00
### Alternative Installing Source from within R
Using the `devtools` the package can also be directly installed from within `R`
```R
library(devtools) # Load the dectools
setwd('< path_to_repo > /CVE') # Go into package root
(path < - build ( vignettes = FALSE)) # Create source package
install.packages(path, repos = NULL, type = "source") # Install source package
library(CVE) # Test
```
2019-11-20 18:03:21 +00:00
2019-12-17 11:07:33 +00:00
### Windows / macOS
Installing from source (for any package which contains compiled code, in our case `C` ) on Windows and MacOS requires additional tools.
See _R Installation and Administration_ from [r-project manuals ](https://cran.r-project.org/manuals.html ).
2019-11-20 18:03:21 +00:00
2019-12-17 11:07:33 +00:00
# Repository Structure
The repository is structured in two directories, the `CVE/` directory which is the `R` package root and `simulations/` where all simulation scripts can be found (and `README.md` which is this).