diff --git a/README.Rmd b/README.Rmd index e75ee5d6bfcebe89d2af2ffd85f1b41bd7d902e9..75711a9bf851e01ff00dd72442e82a557cee2fe6 100644 --- a/README.Rmd +++ b/README.Rmd @@ -29,20 +29,28 @@ Details about the used methodology to calculate the zonal statistics are availab ## Installation -Windows users: there is an open [issue](https://github.com/rfsaldanha/brclimr/issues/1) impeding the use of the package on this operational system. If this is your case, we recommend downloading the Parquet files and locally querying them. More information about this procedure [here](https://rfsaldanha.github.io/brclimr/articles/parquet_files.html). +### Linux and MacOS -### Stable version +#### Stable version ```{r eval=FALSE} install.packages("brclimr") ``` -### Development version +#### Development version ```{r eval=FALSE} remotes::install_github(repo = "rfsaldanha/brclimr") ``` +### Windows + +```{r eval=FALSE} +remotes::install_github(repo = "rfsaldanha/brclimr", ref = "arrow") +``` + +Note: due to an [issue](https://github.com/rfsaldanha/brclimr/issues/1) with a package dependency, we adopted a different approach to query parquet files on S3 buckets under Windows OS. This solution is slower, and we expect to archive this branch as soon as the issue is resolved. + ## Example To fetch data for a specific product, indicator and statistic, use the `fetch_data` function. For example: Rio de Janeiro, RJ (IBGE code number 3304557), data product "brdwgd", average relative humidity, from 2010-10-15 to 2010-10-20. diff --git a/README.md b/README.md index 95d1878c81b5800159de2e1165ebe690e7a9ce68..33e5b5f1a13e7e2844b15314762b63aa5adcae15 100644 --- a/README.md +++ b/README.md @@ -29,25 +29,31 @@ available at *Articles \> Methodology*. ## Installation -Windows users: there is an open -[issue](https://github.com/rfsaldanha/brclimr/issues/1) impeding the use -of the package on this operational system. If this is your case, we -recommend downloading the Parquet files and locally querying them. More -information about this procedure -[here](https://rfsaldanha.github.io/brclimr/articles/parquet_files.html). +### Linux and MacOS -### Stable version +#### Stable version ``` r install.packages("brclimr") ``` -### Development version +#### Development version ``` r remotes::install_github(repo = "rfsaldanha/brclimr") ``` +### Windows + +``` r +remotes::install_github(repo = "rfsaldanha/brclimr", ref = "arrow") +``` + +Note: due to an [issue](https://github.com/rfsaldanha/brclimr/issues/1) +with a package dependency, we adopted a different approach to query +parquet files on S3 buckets under Windows OS. This solution is slower, +and we expect to archive this branch as soon as the issue is resolved. + ## Example To fetch data for a specific product, indicator and statistic, use the @@ -139,7 +145,7 @@ ggplot(data = rbind(tmax, tmin), aes(x = date, y = value, color = name)) + theme(legend.position = "bottom", legend.direction = "horizontal") ``` - + ``` r ggplot(data = pr, aes(x = date, y = value)) + @@ -156,4 +162,4 @@ ggplot(data = pr, aes(x = date, y = value)) + theme(legend.position = "bottom", legend.direction = "horizontal") ``` - + diff --git a/man/figures/README-unnamed-chunk-8-1.png b/man/figures/README-unnamed-chunk-8-1.png index b29408fe8490ec4223f7776f75a566b08152416b..77a54858d02a661f3d3e15976cc5af9c7d8b347f 100644 Binary files a/man/figures/README-unnamed-chunk-8-1.png and b/man/figures/README-unnamed-chunk-8-1.png differ diff --git a/man/figures/README-unnamed-chunk-9-1.png b/man/figures/README-unnamed-chunk-9-1.png new file mode 100644 index 0000000000000000000000000000000000000000..b29408fe8490ec4223f7776f75a566b08152416b Binary files /dev/null and b/man/figures/README-unnamed-chunk-9-1.png differ