Skip to content

Commit

Permalink
Update documentation after CRAN release (#226)
Browse files Browse the repository at this point in the history
  • Loading branch information
ranghetti authored Oct 22, 2019
1 parent be7b212 commit ed074d5
Show file tree
Hide file tree
Showing 83 changed files with 2,869 additions and 787 deletions.
15 changes: 14 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,27 @@ Here above the related changes:
* `s2_order()` to order products from LTA.

## New arguments
* `sen2r()` and `s2_download()` have a new argument `order_lta` (default: TRUE) to order SAFE archives not available for direct fownload;
* `sen2r()` and `s2_download()` have a new argument `order_lta` (default: TRUE) to order SAFE archives not available for direct download;
* `s2_gui()` has a new checkbox to set the previous argument.

## Other changes (not related with LTA)
* Function `build_example_param_file()` does no more compute TOA and RGB432T (this to avoid downloading 2 SAFE archives).
* Code coverage was expanded.


<br/>
## **sen2r** CRAN release
_________________________
**`sen2r`** was accepted on CRAN (2017-10-21, version 1.1.0). From now, it is possible to install the CRAN version with the following command:
```r
install.packages("sen2r")
```
The development version -- which may contain updated features -- can still be installed with the following command:
```r
remotes::install_packages_github("ranghetti/sen2r")
```


# Version 1.1.0

## Changes in default values
Expand Down
10 changes: 7 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,12 @@ can also be performed using intermediate functions (see [usage](#usage)).

### Install locally

The package can be installed from GitHub with the R package **remotes**:
The package can be installed from CRAN:
```{r, eval = FALSE}
install.packages("sen2r")
```

Alternatively, the development version can be installed from GitHub with the R package **remotes**:
```{r, eval = FALSE}
remotes::install_github("ranghetti/sen2r")
```
Expand All @@ -80,7 +85,6 @@ see the [Installation](http://sen2r.ranghetti.info/articles/installation.html) p
### Run as Docker image

A dockerised version of <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> is available [here](https://hub.docker.com/r/ranghetti/sen2r).

For detailed instructions about using it, see the page ["Run in a Docker container"](http://sen2r.ranghetti.info/articles/docker.html) page.


Expand Down Expand Up @@ -161,7 +165,7 @@ is released under the [Creative Commons Attribution-ShareAlike 4.0 International

To cite this library, please use the following entry:

Ranghetti, L.\ and Busetto, L.\ (`r strftime(Sys.Date(),"%Y")`). *sen2r: Find, Download and Process Sentinel-2 Data*. R package version `r packageVersion("sen2r")`. DOI: [10.5281/zenodo.1240384](https://dx.doi.org/10.5281/zenodo.1240384). URL: [http://sen2r.ranghetti.info](http://sen2r.ranghetti.info).
Ranghetti, L.\ and Busetto, L.\ (`r strftime(Sys.Date(),"%Y")`). *sen2r: Find, Download and Process Sentinel-2 Data*. R package version `r devtools::load_all("."); packageVersion("sen2r")`. DOI: [10.5281/zenodo.1240384](https://dx.doi.org/10.5281/zenodo.1240384). URL: [http://sen2r.ranghetti.info](http://sen2r.ranghetti.info).

```bibtex
@Manual{sen2r,
Expand Down
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,14 @@ existing products) can also be performed using intermediate functions

### Install locally

The package can be installed from GitHub with the R package **remotes**:
The package can be installed from CRAN:

``` r
install.packages("sen2r")
```

Alternatively, the development version can be installed from GitHub with
the R package **remotes**:

``` r
remotes::install_github("ranghetti/sen2r")
Expand All @@ -89,9 +96,8 @@ page.

A dockerised version of
<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>
is available [here](https://hub.docker.com/r/ranghetti/sen2r).

For detailed instructions about using it, see the page [“Run in a Docker
is available [here](https://hub.docker.com/r/ranghetti/sen2r). For
detailed instructions about using it, see the page [“Run in a Docker
container”](http://sen2r.ranghetti.info/articles/docker.html) page.

## Usage
Expand Down Expand Up @@ -184,7 +190,7 @@ International license](https://creativecommons.org/licenses/by-sa/4.0)
To cite this library, please use the following entry:

Ranghetti, L. and Busetto, L. (2019). *sen2r: Find, Download and Process
Sentinel-2 Data*. R package version 1.0.0. DOI:
Sentinel-2 Data*. R package version 1.2.0. DOI:
[10.5281/zenodo.1240384](https://dx.doi.org/10.5281/zenodo.1240384).
URL: <http://sen2r.ranghetti.info>.

Expand All @@ -193,7 +199,7 @@ URL: <http://sen2r.ranghetti.info>.
title = {sen2r: Find, Download and Process Sentinel-2 Data},
author = {Luigi Ranghetti and Lorenzo Busetto},
year = {2019},
note = {R package version 1.0.0},
note = {R package version 1.2.0},
doi = {10.5281/zenodo.1240384},
url = {http://sen2r.ranghetti.info},
}
Expand Down
19 changes: 14 additions & 5 deletions _pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,22 @@ reference:
- '`normalize_path`'
navbar:
type: inverse
left:
- text: "Home"
left: []
right:
- icon: fa-home fa-lg
href: index.html
- text: "Function reference"
- text: "\u2000Reference"
icon: fa-file-code
href: reference/index.html
- text: "News"
- text: "\u2000Articles"
icon: fa-book
menu:
- text: "Installation"
href: articles/installation.html
- text: "Run in a Docker container"
href: articles/docker.html
- text: "\u2000Changelog"
icon: fa-newspaper
href: news/index.html
right:
- icon: fa-github fa-lg
href: https://github.com/ranghetti/sen2r/
45 changes: 37 additions & 8 deletions docs/404.html

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

45 changes: 37 additions & 8 deletions docs/CONDUCT.html

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

Loading

0 comments on commit ed074d5

Please sign in to comment.