plotdap/README.Rmd at master · rmendels/plotdap · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# plotdap

The `plotdap` package makes it easy to map data acquired via the `rerddap` functions `tabledap()` or `griddap()`.

## Installation

You can install the released version of plotdap from [CRAN](https://CRAN.R-project.org) with:

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

The development version is available from Github and can be installed with:

```r
devtools::install_github('rmendels/plotdap')
```

## Functions

**plotdap** has six main functions and can produce plots in both base graphics
and `ggplot2` graphics,  though certain features ony work wih `ggplot2`:

- `plotdap()` which sets up the base map:

    + `plotdap(method = c("ggplot2", "base"), mapData = maps::map("world",
             plot = FALSE, fill = TRUE), crs = NULL, datum = sf::st_crs(4326),
             mapTitle = NULL, mapFill = "gray80", mapColor = "gray90", ...)`

-  `add_tabledap()` which adds the results from a `rerddap::tabledap()` call:

    + `add_tabledap(plot, table, var, color = c("#132B43", "#56B1F7"),
                   size = 1.5, shape = 19, animate = FALSE,
                   cumulative = FALSE, ...)`
-  `add_griddap()` which adds the results from a `rerddap::griddap()` call:

    + `add_griddap(plot, grid, var, fill = "viridis", maxpixels = 10000,
                 time = mean, animate = FALSE, cumulative = FALSE, ...)`
-  `add_ggplot()` allows customization of the plot when `ggplot2` is used:

    + `add_ggplot(plot, ...)`

- `bbox_set()`  which resets the bounding box as well as prepare the object foe interactive plotting:

    +  'bbox_set(plotobj, landmask = TRUE, xlim = NULL, ylim = NULL, interactive =    FALSE)'

- `add_griddap_contours()` which adds contours to a `add_griddap()` object:

    + `add_griddap_contours <- function(p,
                                 data,
                                 var,
                                 n_breaks  = 10L,
                                 breaks    = NULL,
                                 lon_col   = "longitude",
                                 lat_col   = "latitude",
                                 color     = "black",
                                 linewidth = 0.3,
                                 alpha     = 1,
                                 crs       = 4326L)`


## Examples

Extensive examples are gven in the vignette,  which can also be viewed at:

https://rmendels.github.io/Using_plotdap.html