Skip to content

Commit 9db61fa

Browse files
committed
remove mlegp installation from README.md
1 parent 8aa206b commit 9db61fa

File tree

4 files changed

+36
-51
lines changed

4 files changed

+36
-51
lines changed

CRAN-SUBMISSION

Lines changed: 0 additions & 3 deletions
This file was deleted.

README-example-1.png

359 Bytes
Loading

README.Rmd

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,6 @@ description at
3535

3636
## Installation
3737
```{r, eval = FALSE}
38-
# install mlegp dependency which unfortunately is going to be archived from CRAN
39-
install.packages("https://cran.r-project.org/src/contrib/mlegp_3.1.8.tar.gz", repos=NULL)
40-
# or
41-
install.packages("https://cran.r-project.org/src/contrib/Archive/mlegp/mlegp_3.1.7.tar.gz", repos=NULL)
42-
4338
# Release stable version from CRAN
4439
install.packages("REddyProc")
4540

README.md

Lines changed: 36 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,28 @@
1-
---
2-
output:
3-
github_document
4-
---
51

62
<!--
73
README.md is generated from README.Rmd. Please edit that file
84
#knitr::knit("README.Rmd")
95
rmarkdown::render("README.Rmd")
106
maybe clear cache before
117
-->
12-
138
<!-- badges: start -->
9+
1410
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/REddyProc)](http://cran.r-project.org/package=REddyProc)
1511
[![R-CMD-check](https://github.com/bgctw/REddyProc/workflows/R-CMD-check/badge.svg)](https://github.com/bgctw/REddyProc/actions)
1612
<!-- badges: end -->
1713

1814
## Overview
1915

20-
`REddyProc` package supports processing (half)hourly data from Eddy-Covariance sensors.
16+
`REddyProc` package supports processing (half)hourly data from
17+
Eddy-Covariance sensors.
2118

22-
There is an online-formular to use the functionality of the package including
23-
description at
19+
There is an online-formular to use the functionality of the package
20+
including description at
2421
<https://www.bgc-jena.mpg.de/bgi/index.php/Services/REddyProcWeb>.
2522

2623
## Installation
2724

28-
```r
29-
# install mlegp dependency which unfortunately is going to be archived from CRAN
30-
install.packages("https://cran.r-project.org/src/contrib/mlegp_3.1.8.tar.gz", repos=NULL)
31-
# or
32-
install.packages("https://cran.r-project.org/src/contrib/Archive/mlegp/mlegp_3.1.7.tar.gz", repos=NULL)
33-
25+
``` r
3426
# Release stable version from CRAN
3527
install.packages("REddyProc")
3628

@@ -39,23 +31,22 @@ install.packages("REddyProc")
3931
devtools::install_github("bgctw/REddyProc")
4032
```
4133

42-
The REddyProc~package requires a quite recent
43-
versions of the tidyverse packages. On encountering problems on installations
44-
with older versions should run the following code before installing REddyProc.
34+
The REddyProc~package requires a quite recent versions of the tidyverse
35+
packages. On encountering problems on installations with older versions
36+
should run the following code before installing REddyProc.
4537

46-
```r
38+
``` r
4739
install.packages("tidyverse")
4840
update.packages(oldPkgs="dplyr")
4941
```
5042

5143
## Usage
5244

5345
A simple example performs Lookuptable-based gapfilling of
54-
Net-Ecosystem-Exchange (NEE) and plotting a fingerprint plot of the filled
55-
values.
56-
46+
Net-Ecosystem-Exchange (NEE) and plotting a fingerprint plot of the
47+
filled values.
5748

58-
```r
49+
``` r
5950
library(REddyProc)
6051
#+++ Input data from csv (example needs to be downloaded)
6152
examplePath <- getExamplePath('Example_DETha98.txt', isTryDownload = TRUE)
@@ -93,44 +84,46 @@ FilledEddyData <- EProc$sExportResults()
9384
EProc$sPlotFingerprintY('NEE_f', Year = 1998)
9485
```
9586

96-
![plot of chunk example](README-example-1.png)
97-
98-
87+
![](README-example-1.png)<!-- -->
9988

10089
Further examples are in
10190
[vignette(useCase)](https://github.com/bgctw/REddyProc/blob/master/vignettes/useCase.md)
10291
and
10392
[vignette(DEGebExample)](https://github.com/bgctw/REddyProc/blob/master/vignettes/DEGebExample.md)
104-
and further md-files of the
105-
[vignettes directory](https://github.com/bgctw/REddyProc/blob/master/vignettes).
106-
93+
and further md-files of the [vignettes
94+
directory](https://github.com/bgctw/REddyProc/blob/master/vignettes).
10795

10896
## Docker images
109-
Docker images are provided that comprise rstudio, rocker/tidyverse, and REddyProc.
110-
There are different version for the latest push to github, for the version on CRAN and for specific tags starting
111-
from 1.1.4.
11297

113-
- bgctw/reddyproc:latest
98+
Docker images are provided that comprise rstudio, rocker/tidyverse, and
99+
REddyProc. There are different version for the latest push to github,
100+
for the version on CRAN and for specific tags starting from 1.1.4.
101+
102+
- bgctw/reddyproc:latest
114103
- bgctw/reddyproc_cran
115104
- bgctw/reddyproc:`tag`
116105

117106
They are usually run with installed docker by typing at a shell:
118-
```
119-
docker run --rm -p 8787:8787 -e PASSWORD=REddyProc <imagename>
120-
```
121-
Then the loading url `localhost:8787` in a browser window should bring up RStudio
107+
108+
docker run --rm -p 8787:8787 -e PASSWORD=REddyProc <imagename>
109+
110+
Then the loading url `localhost:8787` in a browser window should bring
111+
up RStudio
122112
(default username is rstudio and password was set to REddyProc), where
123113
you can type the above usage example.
124114

125-
For processing your own files in docker you need to mount local directories
126-
with the [--mount option](https://docs.docker.com/storage/bind-mounts/), e.g.
115+
For processing your own files in docker you need to mount local
116+
directories with the [–mount
117+
option](https://docs.docker.com/storage/bind-mounts/), e.g.
127118
`--mount type=bind,source=/home/twutz/devR,target=/home/rstudio/devR -e USERID=$UID`
128119

129120
## Reference
130-
The methodology and benchmark of `REddyProc` 1.1.3 is described
131-
in the following paper:
132-
133-
Wutzler, T., Lucas-Moffat, A., Migliavacca, M., Knauer, J., Sickel, K., Šigut, L., Menzer, O., and Reichstein, M. (2018): Basic and extensible post-processing of eddy covariance flux data with REddyProc, Biogeosciences, 15, 5015-5030, [https://doi.org/10.5194/bg-15-5015-2018](https://doi.org/10.5194/bg-15-5015-2018).
134-
135121

122+
The methodology and benchmark of `REddyProc` 1.1.3 is described in the
123+
following paper:
136124

125+
Wutzler, T., Lucas-Moffat, A., Migliavacca, M., Knauer, J., Sickel, K.,
126+
Šigut, L., Menzer, O., and Reichstein, M. (2018): Basic and extensible
127+
post-processing of eddy covariance flux data with REddyProc,
128+
Biogeosciences, 15, 5015-5030,
129+
<https://doi.org/10.5194/bg-15-5015-2018>.

0 commit comments

Comments
 (0)