Skip to content

Commit

Permalink
Update documentation about installation
Browse files Browse the repository at this point in the history
  • Loading branch information
ranghetti committed May 21, 2020
1 parent b3d26eb commit 3656820
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 16 deletions.
3 changes: 2 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,9 @@ are strongly encouraged to cite this publication within their work (see [Credits

The package can be installed from CRAN:
```{r, eval = FALSE}
install.packages("sen2r")
install.packages("sen2r", dependencies = TRUE)
```
Note that argument `dependencies = TRUE` is needed to be able to run all the package's features.

For detailed instructions about installing the package (including dependencies),
see the [Installation](http://sen2r.ranghetti.info/articles/installation.html) page.
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,12 @@ work are strongly encouraged to cite this publication within their work
The package can be installed from CRAN:

``` r
install.packages("sen2r")
install.packages("sen2r", dependencies = TRUE)
```

Note that argument `dependencies = TRUE` is needed to be able to run all
the package’s features.

For detailed instructions about installing the package (including
dependencies), see the
[Installation](http://sen2r.ranghetti.info/articles/installation.html)
Expand Down
15 changes: 9 additions & 6 deletions docs/articles/installation.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,9 @@ are strongly encouraged to cite this publication within their work (see [Credits

The package can be installed from CRAN:
```{r, eval = FALSE}
install.packages("sen2r")
install.packages("sen2r", dependencies = TRUE)
```
Note that argument `dependencies = TRUE` is needed to be able to run all the package's features.

For detailed instructions about installing the package (including dependencies),
see the [Installation](articles/installation.md) page.
Expand Down
5 changes: 4 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,12 @@ work are strongly encouraged to cite this publication within their work
The package can be installed from CRAN:

``` r
install.packages("sen2r")
install.packages("sen2r", dependencies = TRUE)
```

Note that argument `dependencies = TRUE` is needed to be able to run all
the package’s features.

For detailed instructions about installing the package (including
dependencies), see the [Installation](articles/installation.md) page.

Expand Down
15 changes: 9 additions & 6 deletions vignettes/installation.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,9 @@ Moreover, if no personal libraries already exist, it is asked to create a new on

After that, the package can be installed from CRAN:
```{r, eval = FALSE}
install.packages("sen2r")
install.packages("sen2r", dependencies = TRUE)
```
Packages required to run the GUI are suggested dependencies; for this reason, the argument `dependencies = TRUE` is needed to be able to run all the package's features. It can be skipped if the user is not interested to use the GUI.

Alternatively, the development version can be installed from GitHub with the R package **remotes**.
To do it:
Expand All @@ -129,7 +130,7 @@ To do it:
style="color:#2f66d5;vertical-align:baseline;font-size:90%;font-weight:bold;">r</span>:
```{r, eval = FALSE}
library(remotes)
install_github("ranghetti/sen2r")
install_github("ranghetti/sen2r", dependencies = TRUE)
```
This will install the R package along with its package dependencies,
Expand All @@ -154,8 +155,9 @@ update.packages(ask = FALSE)

<span style="color:#5793dd;vertical-align:top;font-size:90%;font-weight:normal;">sen</span><span style="color:#6a7077;vertical-align:baseline;font-size:115%;font-weight:bolder;">2</span><span style="color:#2f66d5;vertical-align:baseline;font-size:90%;font-weight:bold;">r</span> can be installed from CRAN:
```{r, eval = FALSE}
install.packages("sen2r")
install.packages("sen2r", dependencies = TRUE)
```
Packages required to run the GUI are suggested dependencies; for this reason, the argument `dependencies = TRUE` is needed to be able to run all the package's features. It can be skipped if the user is not interested to use the GUI.

Alternatively, the development version can be installed from GitHub with the R package **remotes**.
To do it:
Expand All @@ -170,7 +172,7 @@ To do it:
style="color:#2f66d5;vertical-align:baseline;font-size:90%;font-weight:bold;">r</span>:
```{r, eval = FALSE}
library(remotes)
install_github("ranghetti/sen2r")
install_github("ranghetti/sen2r", dependencies = TRUE)
```
This will install the R package along with its package dependencies,
Expand Down Expand Up @@ -244,8 +246,9 @@ __after__ having installed GDAL as described above.

<span style="color:#5793dd;vertical-align:top;font-size:90%;font-weight:normal;">sen</span><span style="color:#6a7077;vertical-align:baseline;font-size:115%;font-weight:bolder;">2</span><span style="color:#2f66d5;vertical-align:baseline;font-size:90%;font-weight:bold;">r</span> can be installed from CRAN:
```{r, eval = FALSE}
install.packages("sen2r")
install.packages("sen2r", dependencies = TRUE)
```
Packages required to run the GUI are suggested dependencies; for this reason, the argument `dependencies = TRUE` is needed to be able to run all the package's features. It can be skipped if the user is not interested to use the GUI.

Alternatively, the development version can be installed from GitHub with the R package **remotes**.
To do it:
Expand All @@ -260,7 +263,7 @@ To do it:
style="color:#2f66d5;vertical-align:baseline;font-size:90%;font-weight:bold;">r</span>:
```{r, eval = FALSE}
library(remotes)
install_github("ranghetti/sen2r")
install_github("ranghetti/sen2r", dependencies = TRUE)
```
This will install the R package along with its package dependencies,
Expand Down

0 comments on commit 3656820

Please sign in to comment.