diff --git a/404.html b/404.html index fa78beca..d07ffad9 100644 --- a/404.html +++ b/404.html @@ -25,7 +25,7 @@ - +
- +
@@ -110,16 +110,16 @@

Page not found (404)

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/Visualization-tools.html b/articles/Visualization-tools.html index 93c96d43..1acc45c5 100644 --- a/articles/Visualization-tools.html +++ b/articles/Visualization-tools.html @@ -18,15 +18,13 @@ - - - +
- +
@@ -92,9 +90,9 @@

Visualization tools

Elio Campitelli

-

2024-06-04

+

2024-08-28

- Source: vignettes/Visualization-tools.Rmd + Source: vignettes/Visualization-tools.Rmd
@@ -619,10 +617,12 @@

Other scalesgeom_contour2(aes(color = after_stat(level))))

While this is fine, since pressure levels are roughly proportional to -\(\mathrm{e}^{-z}\) in meteorology we -usually plot the vertical coordinate as \(-\log(p)\). However, while ggplot2 has -scale_y_log10() and scale_y_reverse(), they -don’t work together. metR defines the new transformation +e−z\mathrm{e}^{-z} +in meteorology we usually plot the vertical coordinate as +−log(p)-\log(p). +However, while ggplot2 has scale_y_log10() and +scale_y_reverse(), they don’t work together. +metR defines the new transformation reverselog_trans() that can be used with any scale but that is the default for scale_*_level().

On the other hand, scale_*_latitude() (and @@ -666,9 +666,7 @@

geom_relief - -

+
@@ -681,16 +679,16 @@

geom_relief

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/Working-with-data.html b/articles/Working-with-data.html index 44e3a7a1..60113d6b 100644 --- a/articles/Working-with-data.html +++ b/articles/Working-with-data.html @@ -18,15 +18,13 @@ - - - +
- +
@@ -92,9 +90,9 @@

Working with data

Elio Campitelli

-

2024-06-04

+

2024-08-28

- Source: vignettes/Working-with-data.Rmd + Source: vignettes/Working-with-data.Rmd
@@ -418,9 +416,8 @@

Thermodynamics
 # Density of air at 20°C and 1030hPa.
 (rho <- IdealGas(1013*100, 20 + 273.15))
-#> [1] 1.203788

-
-
+#> [1] 1.203788
+
 # Of course, the temperature of air at that density 
 # and same pressure is 20°C.
 IdealGas(1013*100, rho = rho) - 273.15
@@ -429,15 +426,14 @@ 
Thermodynamics
-
+
-
-
+#> [1] 0.7380251
+
 # Mixing ratio
 ws <- MixingRatio(p, ClausiusClapeyron(t))
 (w <- ws*rh)
@@ -451,9 +447,7 @@ 
Thermodynamics
 
-        
-

+
@@ -466,16 +460,16 @@

Thermodynamics

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/index.html b/articles/index.html index 5b9896a4..0446802c 100644 --- a/articles/index.html +++ b/articles/index.html @@ -3,7 +3,7 @@ - +
- +
@@ -77,15 +77,15 @@

All vignettes

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/authors.html b/authors.html index 610bd7c2..31351492 100644 --- a/authors.html +++ b/authors.html @@ -3,7 +3,7 @@ - +
- +
@@ -60,7 +60,7 @@

Authors and Citation

- +
-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/index.html b/index.html index 1f386b0d..2d496d3e 100644 --- a/index.html +++ b/index.html @@ -26,7 +26,7 @@ - +
- +
@@ -228,16 +228,16 @@

Dev status

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/news/index.html b/news/index.html index 07ef93a8..d3021d6d 100644 --- a/news/index.html +++ b/news/index.html @@ -3,7 +3,7 @@ - +
- +

Changelog

- Source: NEWS.md + Source: NEWS.md

metR (development version)

New features

-
  • -EOF()’s rotate argument now will take a function to apply to the EOF loadings. rotate = TRUE is still supported but deprecated and will default to using function(x) stats::varimax(x, normalize = FALSE).
    • +

    • EOF()’s rotate argument now will take a function to apply to the EOF loadings. rotate = TRUE is still supported but deprecated and will default to using function(x) stats::varimax(x, normalize = FALSE).

      • +

    • Contour functions gain a proj.latlon to decide if the projection needs to go to latlon coordinates or to projected coordinates.

Breaking changes

@@ -250,7 +250,7 @@

metR 0.7.0202

New features

  • FitWave() and related functions return NAs when the inputted signal has NAs.

  • FitLm() accepts a weights argument to perform weighted regression.

    • -

  • ReadNetCDF() now can read files directly from DAP servers and other urls, and objects returned by ncdf4 :  : ncopen().

    • +

  • ReadNetCDF() now can read files directly from DAP servers and other urls, and objects returned by ncdf4::ncopen()ncdf4::nc_open().

Bugfixes

@@ -270,7 +270,7 @@

New features

  • EPflux() computes Eliassen-Palm fluxes (experimental).

  • geom_arrow() and geom_vector() should plot faster.

  • New functions is.full_season() and seasonaly().

    • -

  • FitLm() returns model r2 and adjusted r2.

    • +

  • FitLm() returns model r2r^2 and adjusted r2r^2.

  • FitLm() adds names to unnamed terms.

  • New function WaveEnvelope() that computes… the wave envelope.

  • geom_contour2(), geom_contour_fill() and geom_text_contour() now accept a global.breaks argument that controls whether breaks should be computed once using the range of the whole dataset or once for every grouping (e.g. faceting). TRUE (the default) ensures that intervals between contours are comparable between panels. Setting it to FALSE computes contours compatible with ggplot2::geom_conotur() (#109, thanks @freeseek)

    • @@ -466,15 +466,15 @@

    metR 0.1.0 -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/pkgdown.yml b/pkgdown.yml index 8e5d7c2f..876624d3 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,11 +1,10 @@ pandoc: 3.1.11 -pkgdown: 2.0.9 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: Visualization-tools: Visualization-tools.html Working-with-data: Working-with-data.html -last_built: 2024-06-04T03:40Z +last_built: 2024-08-28T03:28Z urls: reference: https://eliocamp.github.io/metR/reference article: https://eliocamp.github.io/metR/articles - diff --git a/reference/%~%.html b/reference/%~%.html new file mode 100644 index 00000000..c4de0255 --- /dev/null +++ b/reference/%~%.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Adiabat.html b/reference/Adiabat.html new file mode 100644 index 00000000..432fd97a --- /dev/null +++ b/reference/Adiabat.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/AnchorBreaks.html b/reference/AnchorBreaks.html new file mode 100644 index 00000000..ebc737b8 --- /dev/null +++ b/reference/AnchorBreaks.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Angle.html b/reference/Angle.html new file mode 100644 index 00000000..668287d8 --- /dev/null +++ b/reference/Angle.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Anomaly.html b/reference/Anomaly.html index 4f5b8861..528cf56e 100644 --- a/reference/Anomaly.html +++ b/reference/Anomaly.html @@ -3,7 +3,7 @@ - +
    - +

    Anomalies

    - Source: R/small_funs.R + Source: R/small_funs.R
    @@ -71,29 +71,29 @@

    Anomalies

    Arguments

    -
    x
    + + +
    x

    numeric vector

    -
    baseline
    +
    baseline

    logical or numerical vector used for subsetting x before computing the mean

    -
    ...
    +
    ...

    other arguments passed to mean such as na.rm

    Value

    - - -

    A numeric vector of the same length as x with each value's distance to the +

    A numeric vector of the same length as x with each value's distance to the mean.

    See also

    -

    Other utilities: +

    Other utilities: JumpBy(), Mag(), Percentile(), @@ -133,15 +133,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/AssignSeason.html b/reference/AssignSeason.html new file mode 100644 index 00000000..8f528ffd --- /dev/null +++ b/reference/AssignSeason.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/BuildWave.html b/reference/BuildWave.html new file mode 100644 index 00000000..ed7624ba --- /dev/null +++ b/reference/BuildWave.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ClausiusClapeyron.html b/reference/ClausiusClapeyron.html new file mode 100644 index 00000000..432fd97a --- /dev/null +++ b/reference/ClausiusClapeyron.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ConvertLongitude.html b/reference/ConvertLongitude.html index a071e4b7..22813974 100644 --- a/reference/ConvertLongitude.html +++ b/reference/ConvertLongitude.html @@ -3,7 +3,7 @@ - +
    - +

    Converts between longitude conventions

    - Source: R/ConvertLongitude.R + Source: R/ConvertLongitude.R
    @@ -71,24 +71,24 @@

    Converts between longitude conventions

    Arguments

    -
    lon
    + + +
    lon

    numeric vector of longitude

    -
    group
    +
    group

    optional vector of groups (the same length as longitude) that will be split on the edges (see examples)

    -
    from
    +
    from

    optionally explicitly say from which convention to convert

    Value

    - - -

    If group is missing, a numeric vector the same length of lon. +

    If group is missing, a numeric vector the same length of lon. Else, a list with vectors lon and group.

    @@ -96,7 +96,6 @@

    Value

    Examples

    library(ggplot2)
 library(data.table)
-data.table::setDTthreads(1)
 data(geopotential)
 
 ggplot(geopotential[date == date[1]], aes(lon, lat, z = gh)) +
@@ -138,15 +137,15 @@ 
    Examples
    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/Derivate.html b/reference/Derivate.html index 7456fd7f..4ca7521b 100644 --- a/reference/Derivate.html +++ b/reference/Derivate.html @@ -3,7 +3,7 @@ - +
    - +

    Derivate a discrete variable using finite differences

    - Source: R/Derivate.R + Source: R/Derivate.R
    @@ -110,45 +110,45 @@

    Derivate a discrete variable using finite differences

    Arguments

    -
    formula
    + + +
    formula

    a formula indicating dependent and independent variables

    -
    order
    +
    order

    order of the derivative

    -
    cyclical
    +
    cyclical

    logical vector of boundary condition for each independent variable

    -
    fill
    +
    fill

    logical indicating whether to fill values at the boundaries with forward and backwards differencing

    -
    data
    +
    data

    optional data.frame containing the variables

    -
    sphere
    +
    sphere

    logical indicating whether to use spherical coordinates (see details)

    -
    a
    +
    a

    radius to use in spherical coordinates (defaults to Earth's radius)

    -
    equispaced
    +
    equispaced

    logical indicating whether points are equispaced or not.

    Value

    - - -

    If there is one independent variable and one dependent variable, a numeric +

    If there is one independent variable and one dependent variable, a numeric vector of the same length as the dependent variable. If there are two or more independent variables or two or more dependent variables, a list containing the directional derivatives of each dependent variables.

    @@ -171,7 +171,7 @@

    Details

    See also

    -

    Other meteorology functions: +

    Other meteorology functions: EOF(), GeostrophicWind(), WaveFlux(), @@ -232,15 +232,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/Detrend.html b/reference/Detrend.html new file mode 100644 index 00000000..0726e205 --- /dev/null +++ b/reference/Detrend.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/DewPoint.html b/reference/DewPoint.html new file mode 100644 index 00000000..432fd97a --- /dev/null +++ b/reference/DewPoint.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Divergence.html b/reference/Divergence.html new file mode 100644 index 00000000..252af82c --- /dev/null +++ b/reference/Divergence.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/EOF.html b/reference/EOF.html index 7a9ae334..07d5d404 100644 --- a/reference/EOF.html +++ b/reference/EOF.html @@ -4,7 +4,7 @@ - +
    - +

    Empirical Orthogonal Function

    - Source: R/EOF.R + Source: R/EOF.R
    @@ -83,44 +83,46 @@

    Empirical Orthogonal Function

    Arguments

    -
    formula
    + + +
    formula

    a formula to build the matrix that will be used in the SVD decomposition (see Details)

    -
    n
    +
    n

    which singular values to return (if NULL, returns all)

    -
    data
    +
    data

    a data.frame

    -
    B
    +
    B

    number of bootstrap samples used to estimate confidence intervals. Ignored if <= 1.

    -
    probs
    +
    probs

    the probabilities of the lower and upper values of estimated confidence intervals. If named, it's names will be used as column names.

    -
    rotate
    +
    rotate

    a function to apply to the loadings to rotate them. E.g. for varimax rotation use stats::varimax.

    -
    suffix
    +
    suffix

    character to name the principal components

    -
    fill
    +
    fill

    value to infill implicit missing values or NULL if the data is dense.

    -
    engine
    +
    engine

    function to use to compute SVD. If NULL it uses irlba::irlba (if installed) if the largest singular value to compute is lower than half the maximum possible value, otherwise it uses base::svd. If the user provides a function, @@ -130,9 +132,7 @@

    Arguments

    Value

    - - -

    An eof object which is just a named list of data.tables

    left
    +

    An eof object which is just a named list of data.tables

    left

    data.table with left singular vectors

    right
    @@ -174,7 +174,7 @@

    References

    See also

    -

    Other meteorology functions: +

    Other meteorology functions: Derivate(), GeostrophicWind(), WaveFlux(), @@ -184,8 +184,7 @@

    See also

    Examples

    - 
    data.table::setDTthreads(1)
-# The Antarctic Oscillation is computed from the
+    
    # The Antarctic Oscillation is computed from the
 # monthly geopotential height anomalies weighted by latitude.
 library(data.table)
 data(geopotential)
@@ -271,15 +270,15 @@ 
    Examples
    
 
    
 
 
    
-  
    Site built with pkgdown 2.0.9.
    
+  
    Site built with pkgdown 2.1.0.
    - - + + diff --git a/reference/EPflux.html b/reference/EPflux.html index 38813b0f..953e4764 100644 --- a/reference/EPflux.html +++ b/reference/EPflux.html @@ -3,7 +3,7 @@ - +
    - +

    Computes Eliassen-Palm fluxes.

    - Source: R/WaveFlux.R + Source: R/WaveFlux.R
    @@ -71,35 +71,35 @@

    Computes Eliassen-Palm fluxes.

    Arguments

    -
    lon
    + + +
    lon

    longitudes in degrees.

    -
    lat
    +
    lat

    latitudes in degrees.

    -
    lev
    +
    lev

    pressure levels.

    -
    t
    +
    t

    temperature in Kelvin.

    -
    u
    +
    u

    zonal wind in m/s.

    -
    v
    +
    v

    meridional wind in m/s.

    Value

    - - -

    A data.table with columns Flon, Flat and Flev giving the zonal, meridional +

    A data.table with columns Flon, Flat and Flev giving the zonal, meridional and vertical components of the EP Fluxes at each longitude, latitude and level.

    @@ -121,15 +121,15 @@

    References

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/FilterWave.html b/reference/FilterWave.html new file mode 100644 index 00000000..ed7624ba --- /dev/null +++ b/reference/FilterWave.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/FitLm.html b/reference/FitLm.html index 2c4e62f5..f3d5766e 100644 --- a/reference/FitLm.html +++ b/reference/FitLm.html @@ -4,7 +4,7 @@ - +
    - +

    Fast estimates of linear regression

    - Source: R/FitLm.R + Source: R/FitLm.R
    @@ -77,40 +77,40 @@

    Fast estimates of linear regression

    Arguments

    -
    y
    + + +
    y

    numeric vector of observations to model

    -
    ...
    +
    ...

    numeric vectors of variables used in the modelling

    -
    intercept
    +
    intercept

    logical indicating whether to automatically add the intercept

    -
    weights
    +
    weights

    numerical vector of weights (which doesn't need to be normalised)

    -
    se
    +
    se

    logical indicating whether to compute the standard error

    -
    r2
    +
    r2

    logical indicating whether to compute r squared

    -
    time
    +
    time

    time vector to use for detrending. Only necessary in the case of irregularly sampled timeseries

    Value

    - - -

    FitLm returns a list with elements

    term
    +

    FitLm returns a list with elements

    term

    the name of the regressor

    estimate
    @@ -130,8 +130,6 @@

    Value

    ResidLm and Detrend returns a vector of the same length

    - -

    If there's no complete cases in the regression, NAs are returned with no warning.

    @@ -145,7 +143,7 @@

    Examples

    regr <- geopotential[, FitLm(gh, date, se = TRUE), by = .(lon, lat)] }) #> user system elapsed -#> 0.266 0.001 0.266 +#> 0.325 0.000 0.326 ggplot(regr[term != "(Intercept)"], aes(lon, lat)) + geom_contour(aes(z = estimate, color = after_stat(level))) + @@ -153,11 +151,11 @@

    Examples

    # Using stats::lm() is much slower and with no names. -if (FALSE) { +if (FALSE) { # \dontrun{ system.time({ regr <- geopotential[, coef(lm(gh ~ date))[2], by = .(lon, lat)] }) -} +} # }
    @@ -173,15 +171,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/FitWave.html b/reference/FitWave.html new file mode 100644 index 00000000..ed7624ba --- /dev/null +++ b/reference/FitWave.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/GeomArrow.html b/reference/GeomArrow.html new file mode 100644 index 00000000..2f903cdc --- /dev/null +++ b/reference/GeomArrow.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/GeomContour2.html b/reference/GeomContour2.html new file mode 100644 index 00000000..a58f169e --- /dev/null +++ b/reference/GeomContour2.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/GeomContourTanaka.html b/reference/GeomContourTanaka.html new file mode 100644 index 00000000..afd8868a --- /dev/null +++ b/reference/GeomContourTanaka.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/GeomLabelContour.html b/reference/GeomLabelContour.html new file mode 100644 index 00000000..bdd8891d --- /dev/null +++ b/reference/GeomLabelContour.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/GeomRelief.html b/reference/GeomRelief.html new file mode 100644 index 00000000..34a9761e --- /dev/null +++ b/reference/GeomRelief.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/GeomShadow.html b/reference/GeomShadow.html new file mode 100644 index 00000000..34a9761e --- /dev/null +++ b/reference/GeomShadow.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/GeomStreamline.html b/reference/GeomStreamline.html new file mode 100644 index 00000000..be69a05a --- /dev/null +++ b/reference/GeomStreamline.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/GeomTextContour.html b/reference/GeomTextContour.html new file mode 100644 index 00000000..bdd8891d --- /dev/null +++ b/reference/GeomTextContour.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/GeostrophicWind.html b/reference/GeostrophicWind.html index 2a0e663e..6e266658 100644 --- a/reference/GeostrophicWind.html +++ b/reference/GeostrophicWind.html @@ -3,7 +3,7 @@ - +
    - +

    Calculate geostrophic winds

    - Source: R/GeostrophicWind.R + Source: R/GeostrophicWind.R
    @@ -71,35 +71,35 @@

    Calculate geostrophic winds

    Arguments

    -
    gh
    + + +
    gh

    geopotential height

    -
    lon
    +
    lon

    longitude in degrees

    -
    lat
    +
    lat

    latitude in degrees

    -
    cyclical
    +
    cyclical

    boundary condition for longitude (see details)

    -
    g
    +
    g

    acceleration of gravity

    -
    a
    +
    a

    Earth's radius

    Value

    - - -

    A named list with vectors for the zonal and meridional component of geostrophic +

    A named list with vectors for the zonal and meridional component of geostrophic wind.

    @@ -110,7 +110,7 @@

    Details

    See also

    -

    Other meteorology functions: +

    Other meteorology functions: Derivate(), EOF(), WaveFlux(), @@ -158,15 +158,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/GetSMNData.html b/reference/GetSMNData.html index 1120a52b..f0eee247 100644 --- a/reference/GetSMNData.html +++ b/reference/GetSMNData.html @@ -6,7 +6,7 @@ - +
    - +

    Get Meteorological data

    - Source: R/GetSMNData.R + Source: R/GetSMNData.R
    @@ -83,31 +83,31 @@

    Get Meteorological data

    Arguments

    -
    date
    + + +
    date

    date vector of dates to fetch data

    -
    type
    +
    type

    type of data to retrieve

    -
    bar
    +
    bar

    logical object indicating whether to show a progress bar

    -
    cache
    +
    cache

    logical indicating if the results should be saved on disk

    -
    file.dir
    +
    file.dir

    optional directory where to save and/or retrieve data

    Value

    - - -

    For type = "hourly", a data.frame with observations of

    date
    +

    For type = "hourly", a data.frame with observations of

    date

    date

    t
    @@ -173,15 +173,15 @@

    Details

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/GetTopography.html b/reference/GetTopography.html index a61b66f8..5838a9b9 100644 --- a/reference/GetTopography.html +++ b/reference/GetTopography.html @@ -3,7 +3,7 @@ - +
    - +

    Get topographic data

    - Source: R/GetTopography.R + Source: R/GetTopography.R
    @@ -80,33 +80,33 @@

    Get topographic data

    Arguments

    -
    lon.west, lon.east, lat.north, lat.south
    + + +
    lon.west, lon.east, lat.north, lat.south

    latitudes and longitudes of the bounding box in degrees

    -
    resolution
    +
    resolution

    numeric vector indicating the desired resolution (in degrees) in the lon and lat directions (maximum resolution is 1 minute)

    -
    cache
    +
    cache

    logical indicating if the results should be saved on disk

    -
    file.dir
    +
    file.dir

    optional directory where to save and/or retrieve data

    -
    verbose
    +
    verbose

    logical indicating whether to print progress

    Value

    - - -

    A data table with height (in meters) for each longitude and latitude.

    +

    A data table with height (in meters) for each longitude and latitude.

    Details

    @@ -121,7 +121,7 @@

    References

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 topo <- GetTopography(280, 330, 0, -60, resolution = 0.5)
 library(ggplot2)
 ggplot(topo, aes(lon, lat)) +
@@ -129,7 +129,7 @@ 
    Examples
    
     geom_contour(aes(z = h), breaks = 0, color = "black", size = 0.3) +
     scale_fill_gradient2(low = "steelblue", high = "goldenrod2", mid = "olivedrab") +
     coord_quickmap()
-}
+} # }
    @@ -144,15 +144,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/GlanceNetCDF.html b/reference/GlanceNetCDF.html new file mode 100644 index 00000000..fb2b82ee --- /dev/null +++ b/reference/GlanceNetCDF.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/IdealGas.html b/reference/IdealGas.html new file mode 100644 index 00000000..432fd97a --- /dev/null +++ b/reference/IdealGas.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Impute2D.html b/reference/Impute2D.html index ddcfb990..d4f4a5d5 100644 --- a/reference/Impute2D.html +++ b/reference/Impute2D.html @@ -3,7 +3,7 @@ - +
    - +

    Impute missing values by linear or constant interpolation

    - Source: R/Impute2D.R + Source: R/Impute2D.R
    @@ -71,15 +71,17 @@

    Impute missing values by linear or constant interpolation

    Arguments

    -
    formula
    + + +
    formula

    a formula indicating dependent and independent variables (see Details)

    -
    data
    +
    data

    optional data.frame with the data

    -
    method
    +
    method

    "interpolate" for interpolation, a numeric for constant imputation or a function that takes a vector and returns a number (like mean)

    @@ -106,15 +108,15 @@

    Details

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ImputeEOF.html b/reference/ImputeEOF.html index 4ad42959..ecbe618c 100644 --- a/reference/ImputeEOF.html +++ b/reference/ImputeEOF.html @@ -4,7 +4,7 @@ - +
    - +

    Impute missing values

    - Source: R/ImputeEOF.R + Source: R/ImputeEOF.R
    @@ -82,42 +82,42 @@

    Impute missing values

    Arguments

    -
    formula
    + + +
    formula

    a formula to build the matrix that will be used in the SVD decomposition (see Details)

    -
    max.eof, min.eof
    +
    max.eof, min.eof

    maximum and minimum number of singular values used for imputation

    -
    data
    +
    data

    a data.frame

    -
    tol
    +
    tol

    tolerance used for determining convergence

    -
    max.iter
    +
    max.iter

    maximum iterations allowed for the algorithm

    -
    validation
    +
    validation

    number of points to use in cross-validation (defaults to the maximum of 30 or 10% of the non NA points)

    -
    verbose
    +
    verbose

    logical indicating whether to print progress

    Value

    - - -

    A vector of imputed values with attributes eof, which is the number of +

    A vector of imputed values with attributes eof, which is the number of singular values used in the final imputation; and rmse, which is the Root Mean Square Error estimated from cross-validation.

    @@ -248,15 +248,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/Interpolate.html b/reference/Interpolate.html index e0e20b64..853f5ca1 100644 --- a/reference/Interpolate.html +++ b/reference/Interpolate.html @@ -3,7 +3,7 @@ - +
    - +

    Bilinear interpolation

    - Source: R/Interpolate.R + Source: R/Interpolate.R
    @@ -71,23 +71,25 @@

    Bilinear interpolation

    Arguments

    -
    formula
    + + +
    formula

    a formula indicating dependent and independent variables (see Details)

    -
    x.out, y.out
    +
    x.out, y.out

    x and y values where to interpolate (see Details)

    -
    data
    +
    data

    optional data.frame with the data

    -
    grid
    +
    grid

    logical indicating if x.out and y.out define a regular grid.

    -
    path
    +
    path

    a logical or character indicating if the x.out and y.out define a path. If character, it will be the name of the column returning the order of said path.

    @@ -95,9 +97,7 @@

    Arguments

    Value

    - - -

    A data.frame with interpolated values and locations

    +

    A data.frame with interpolated values and locations

    Details

    @@ -181,15 +181,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/JumpBy.html b/reference/JumpBy.html index 5d977e5f..227e929f 100644 --- a/reference/JumpBy.html +++ b/reference/JumpBy.html @@ -3,7 +3,7 @@ - +
    - +

    Skip observations

    - Source: R/small_funs.R + Source: R/small_funs.R
    @@ -71,27 +71,27 @@

    Skip observations

    Arguments

    -
    x
    + + +
    x

    vector

    -
    by
    +
    by

    numeric interval between elements to keep

    -
    start
    +
    start

    index to start from

    -
    fill
    +
    fill

    how observations are skipped

    Value

    - - -

    A vector of the same class as x and, if fill is not null, +

    A vector of the same class as x and, if fill is not null, the same length.

    @@ -100,7 +100,7 @@

    Details

    See also

    -

    Other utilities: +

    Other utilities: Anomaly(), Mag(), Percentile(), @@ -135,15 +135,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/Laplacian.html b/reference/Laplacian.html new file mode 100644 index 00000000..252af82c --- /dev/null +++ b/reference/Laplacian.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/LatLabel.html b/reference/LatLabel.html new file mode 100644 index 00000000..ff3ba20f --- /dev/null +++ b/reference/LatLabel.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/LonLabel.html b/reference/LonLabel.html new file mode 100644 index 00000000..ff3ba20f --- /dev/null +++ b/reference/LonLabel.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Mag.html b/reference/Mag.html index e59ac56f..2be4cee5 100644 --- a/reference/Mag.html +++ b/reference/Mag.html @@ -4,7 +4,7 @@ - +
    - +

    Magnitude and angle of a vector

    - Source: R/small_funs.R + Source: R/small_funs.R
    @@ -75,19 +75,19 @@

    Magnitude and angle of a vector

    Arguments

    -
    ...
    + + +
    ...

    numeric vectors of coordinates or list of coordinates

    -
    x, y,
    +
    x, y,

    x and y directions of the vector

    Value

    - - -

    Mag: A numeric vector the same length as each element of ... +

    Mag: A numeric vector the same length as each element of ... that is \(\sqrt(x^2 + y^2 + ...)\). Angle: A numeric vector of the same length as x and y that is atan2(y, x)*180/pi.

    @@ -99,12 +99,12 @@

    Details

    See also

    -

    Other utilities: +

    Other utilities: Anomaly(), JumpBy(), Percentile(), logic

    -

    Other utilities: +

    Other utilities: Anomaly(), JumpBy(), Percentile(), @@ -123,9 +123,9 @@

    Examples

    #> [1] 20 # There's no vector recicling! -if (FALSE) { +if (FALSE) { # \dontrun{ Mag(1, 1:2) -} +} # }
    @@ -141,15 +141,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/MakeBreaks.html b/reference/MakeBreaks.html index 13fc58ce..d639775d 100644 --- a/reference/MakeBreaks.html +++ b/reference/MakeBreaks.html @@ -4,7 +4,7 @@ - +
    - +

    Functions for making breaks

    - Source: R/MakeBreaks.R + Source: R/MakeBreaks.R
    @@ -75,27 +75,27 @@

    Functions for making breaks

    Arguments

    -
    binwidth
    + + +
    binwidth

    width of breaks

    -
    bins
    +
    bins

    number of bins, used if binwidth = NULL

    -
    exclude
    +
    exclude

    a vector of breaks to exclude

    -
    anchor
    +
    anchor

    anchor value

    Value

    - - -

    A function that takes a range as argument and a binwidth as an optional argument +

    A function that takes a range as argument and a binwidth as an optional argument and returns a sequence of equally spaced intervals covering the range.

    @@ -107,7 +107,7 @@

    Details

    See also

    -

    Other ggplot2 helpers: +

    Other ggplot2 helpers: WrapCircular(), geom_arrow(), geom_contour2(), @@ -166,15 +166,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/MaskLand.html b/reference/MaskLand.html index 6b4cabe7..65c0a20a 100644 --- a/reference/MaskLand.html +++ b/reference/MaskLand.html @@ -3,7 +3,7 @@ - +
    - +

    Mask

    - Source: R/MaskLand.R + Source: R/MaskLand.R
    @@ -71,28 +71,28 @@

    Mask

    Arguments

    -
    lon
    + + +
    lon

    a vector of longitudes in degrees in 0-360 format

    -
    lat
    +
    lat

    a vector of latitudes in degrees

    -
    mask
    +
    mask

    the name of the dataset (that will be load with map) for creating the mask

    -
    wrap
    +
    wrap

    the longitude range to be used for a global mask

    Value

    - - -

    A logical vector of the same length as lat and lon where TRUE means +

    A logical vector of the same length as lat and lon where TRUE means that the point is inside one of the polygons making up the map. For a global map (the default), this means that the point is over land.

    @@ -138,15 +138,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/MixingRatio.html b/reference/MixingRatio.html new file mode 100644 index 00000000..432fd97a --- /dev/null +++ b/reference/MixingRatio.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Percentile.html b/reference/Percentile.html index ebfb83b5..d0589a05 100644 --- a/reference/Percentile.html +++ b/reference/Percentile.html @@ -3,7 +3,7 @@ - +
    - +

    Percentiles

    - Source: R/small_funs.R + Source: R/small_funs.R
    @@ -71,20 +71,20 @@

    Percentiles

    Arguments

    -
    x
    + + +
    x

    numeric vector

    Value

    - - -

    A numeric vector of the same length as x with the percentile of each value +

    A numeric vector of the same length as x with the percentile of each value of x.

    See also

    -

    Other utilities: +

    Other utilities: Anomaly(), JumpBy(), Mag(), @@ -110,15 +110,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ReadNetCDF.html b/reference/ReadNetCDF.html index f148352b..62432d82 100644 --- a/reference/ReadNetCDF.html +++ b/reference/ReadNetCDF.html @@ -5,7 +5,7 @@ - +
    - +

    Read NetCDF files.

    - Source: R/ReadNetCDF.R + Source: R/ReadNetCDF.R
    @@ -83,7 +83,9 @@

    Read NetCDF files.

    Arguments

    -
    file
    + + +
    file

    source to read from. Must be one of:

    • A string representing a local file with read access.

    • A string representing a URL readable by ncdf4::nc_open(). (this includes DAP urls).

      • @@ -91,7 +93,7 @@

      Arguments

    -
    vars
    +
    vars

    one of:

    • NULL: reads all variables.

    • a character vector with the name of the variables to read.

    • a function that takes a vector with all the variables and returns either @@ -100,28 +102,26 @@

      Arguments

    -
    out
    +
    out

    character indicating the type of output desired

    -
    subset
    +
    subset

    a list of subsetting objects. See below.

    -
    key
    +
    key

    if TRUE, returns a data.table keyed by the dimensions of the data.

    -
    ...
    +
    ...

    in GlanceNetCDF(), ignored. Is there for convenience so that a call to ReadNetCDF() can be also valid for GlanceNetCDF().

    Value

    - - -

    The return format is specified by out. It can be a data table in which each +

    The return format is specified by out. It can be a data table in which each column is a variable and each row, an observation; an array with named dimensions; or a vector. Since it's possible to return multiple arrays or vectors (one for each variable), for consistency the return type is always a @@ -129,20 +129,16 @@

    Value

    first since the most time consuming part is the melting of the array returned by ncdf4::ncvar_get. out = "vector" is particularly useful for adding new variables to an existing data frame with the same dimensions.

    - -

    When not all variables specified in vars have the same number of dimensions, the shorter variables will be recycled. E.g. if reading a 3D pressure field and a 2D surface temperature field, the latter will be turned into a 3D field with the same values in each missing dimension.

    - -

    GlanceNetCDF() returns a list of variables and dimensions included in the file with a nice printing method.

    Subsetting

    - +

    In the most basic form, subset will be a named list whose names must match the dimensions specified in the NetCDF file and each element must be a vector @@ -404,7 +400,7 @@

    Examples

    #> 178703: 2010-07-09 10 -90 355.0 188.25 188.25 #> 178704: 2010-07-09 10 -90 357.5 188.25 188.25 -if (FALSE) { +if (FALSE) { # \dontrun{ # Using a DAP url url <- "http://iridl.ldeo.columbia.edu/SOURCES/.Models/.SubX/.GMAO/.GEOS_V2p1/.hindcast/.ua/dods" field <- ReadNetCDF(url, subset = list(M = 1, @@ -425,7 +421,7 @@

    Examples

    # start with "radar_". ReadNetCDF(radar_file, vars = \(x) startsWith(x, "radar_")) -} +} # }
    @@ -440,15 +436,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/RepeatCircular.html b/reference/RepeatCircular.html new file mode 100644 index 00000000..b10c0921 --- /dev/null +++ b/reference/RepeatCircular.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ResidLm.html b/reference/ResidLm.html new file mode 100644 index 00000000..0726e205 --- /dev/null +++ b/reference/ResidLm.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/ScaleDiscretised.html b/reference/ScaleDiscretised.html new file mode 100644 index 00000000..2ac13c89 --- /dev/null +++ b/reference/ScaleDiscretised.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Similar.html b/reference/Similar.html new file mode 100644 index 00000000..c4de0255 --- /dev/null +++ b/reference/Similar.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Smooth2D.html b/reference/Smooth2D.html index 53a1a029..fbeb5381 100644 --- a/reference/Smooth2D.html +++ b/reference/Smooth2D.html @@ -3,7 +3,7 @@ - +
    - +

    Smooths a 2D field

    - Source: R/Smooth2D.R + Source: R/Smooth2D.R
    @@ -75,33 +75,33 @@

    Smooths a 2D field

    Arguments

    -
    x, y
    + + +
    x, y

    Vector of x and y coordinates

    -
    value
    +
    value

    Vector of values

    -
    method
    +
    method

    The method to use smooth. Must be a function that takes a matrix and returns the smoothed matrix. Build-in methods are smooth_svd() and smooth_dct().

    -
    kx, ky
    +
    kx, ky

    Proportion of components to keep in the x and y direction respectively. Lower values increase the smoothness.

    -
    variance_lost
    +
    variance_lost

    Maximum percentage of variance lost after smoothing.

    Value

    - - -

    A vector of the same length as value.

    +

    A vector of the same length as value.

    Details

    @@ -143,15 +143,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/StatArrow.html b/reference/StatArrow.html new file mode 100644 index 00000000..2f903cdc --- /dev/null +++ b/reference/StatArrow.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/StatContour2.html b/reference/StatContour2.html new file mode 100644 index 00000000..a58f169e --- /dev/null +++ b/reference/StatContour2.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/StatContourFill.html b/reference/StatContourFill.html new file mode 100644 index 00000000..31a882e1 --- /dev/null +++ b/reference/StatContourFill.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/StatNa.html b/reference/StatNa.html new file mode 100644 index 00000000..e0155147 --- /dev/null +++ b/reference/StatNa.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/StatStreamline.html b/reference/StatStreamline.html new file mode 100644 index 00000000..be69a05a --- /dev/null +++ b/reference/StatStreamline.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/StatSubset.html b/reference/StatSubset.html new file mode 100644 index 00000000..28025852 --- /dev/null +++ b/reference/StatSubset.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/StatTextContour.html b/reference/StatTextContour.html new file mode 100644 index 00000000..bdd8891d --- /dev/null +++ b/reference/StatTextContour.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Trajectory.html b/reference/Trajectory.html index 9cd70337..1c9a945a 100644 --- a/reference/Trajectory.html +++ b/reference/Trajectory.html @@ -3,7 +3,7 @@ - +
    - +

    Compute trajectories

    - Source: R/Tajectory.R + Source: R/Tajectory.R
    @@ -71,24 +71,26 @@

    Compute trajectories

    Arguments

    -
    formula
    + + +
    formula

    a formula indicating dependent and independent variables in the form of dx + dy ~ x + y + t.

    -
    x0, y0
    +
    x0, y0

    starting coordinates of the particles.

    -
    cyclical
    +
    cyclical

    logical vector of boundary condition for x and y.

    -
    data
    +
    data

    optional data.frame containing the variables.

    -
    res
    +
    res

    resolution parameter (higher numbers increases the resolution)

    @@ -105,15 +107,15 @@

    Arguments

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/VirtualTemperature.html b/reference/VirtualTemperature.html new file mode 100644 index 00000000..432fd97a --- /dev/null +++ b/reference/VirtualTemperature.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/Vorticity.html b/reference/Vorticity.html new file mode 100644 index 00000000..252af82c --- /dev/null +++ b/reference/Vorticity.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/WaveEnvelope.html b/reference/WaveEnvelope.html new file mode 100644 index 00000000..ed7624ba --- /dev/null +++ b/reference/WaveEnvelope.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/WaveFlux.html b/reference/WaveFlux.html index f89eb245..a3db864b 100644 --- a/reference/WaveFlux.html +++ b/reference/WaveFlux.html @@ -3,7 +3,7 @@ - +
    - +

    Calculate wave-activity flux

    - Source: R/WaveFlux.R + Source: R/WaveFlux.R
    @@ -71,43 +71,43 @@

    Calculate wave-activity flux

    Arguments

    -
    gh
    + + +
    gh

    geopotential height

    -
    u
    +
    u

    mean zonal velocity

    -
    v
    +
    v

    mean meridional velocity

    -
    lon
    +
    lon

    longitude (in degrees)

    -
    lat
    +
    lat

    latitude (in degrees)

    -
    lev
    +
    lev

    pressure level (in hPa)

    -
    g
    +
    g

    acceleration of gravity

    -
    a
    +
    a

    Earth's radius

    Value

    - - -

    A list with elements: longitude, latitude, and the two horizontal components +

    A list with elements: longitude, latitude, and the two horizontal components of the wave activity flux.

    @@ -122,7 +122,7 @@

    References

    See also

    -

    Other meteorology functions: +

    Other meteorology functions: Derivate(), EOF(), GeostrophicWind(), @@ -142,15 +142,15 @@

    See also

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/WrapCircular.html b/reference/WrapCircular.html index 84abb0d6..08e99a9e 100644 --- a/reference/WrapCircular.html +++ b/reference/WrapCircular.html @@ -4,7 +4,7 @@ - +
    - +

    Wrap periodic data to any range

    - Source: R/RepeatCircular.R + Source: R/RepeatCircular.R
    @@ -73,28 +73,28 @@

    Wrap periodic data to any range

    Arguments

    -
    x
    + + +
    x

    a data.frame

    -
    circular
    +
    circular

    the name of the circular dimension

    -
    wrap
    +
    wrap

    the wrap for the data to be extended to

    Value

    - - -

    A data.frame.

    +

    A data.frame.

    See also

    geom_contour2

    -

    Other ggplot2 helpers: +

    Other ggplot2 helpers: MakeBreaks(), geom_arrow(), geom_contour2(), @@ -113,8 +113,7 @@

    See also

    Examples

    - 
    data.table::setDTthreads(1)
-
+    
    
 library(ggplot2)
 library(data.table)
 data(geopotential)
@@ -161,15 +160,15 @@ 
    Examples
    
 
    
 
 
    
-  
    Site built with pkgdown 2.0.9.
    
+  
    Site built with pkgdown 2.1.0.
    - - + + diff --git a/reference/as.path.html b/reference/as.path.html index 2138a756..5d7ae4f2 100644 --- a/reference/as.path.html +++ b/reference/as.path.html @@ -4,7 +4,7 @@ - +
    - +

    Interpolates between locations

    - Source: R/Interpolate.R + Source: R/Interpolate.R
    @@ -73,27 +73,25 @@

    Interpolates between locations

    Arguments

    -
    x, y
    + + +
    x, y

    numeric vectors of x and y locations. If one of them is of length 1, if will be recycled.

    -
    n
    +
    n

    number of points to interpolate to

    -
    path
    +
    path

    either TRUE of a character vector with the name of the path.

    Value

    - - -

    A list of components x and y with the list of locations and the path

    - - -

    arguments

    +

    A list of components x and y with the list of locations and the path +arguments

    Details

    @@ -116,15 +114,15 @@

    See also

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/coriolis.dy.html b/reference/coriolis.dy.html new file mode 100644 index 00000000..406fff23 --- /dev/null +++ b/reference/coriolis.dy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/coriolis.html b/reference/coriolis.html index 2640e6fc..839ac91c 100644 --- a/reference/coriolis.html +++ b/reference/coriolis.html @@ -3,7 +3,7 @@ - +
    - +

    Effects of the Earth's rotation

    - Source: R/coriolis.R + Source: R/coriolis.R
    @@ -77,11 +77,13 @@

    Effects of the Earth's rotation

    Arguments

    -
    lat
    + + +
    lat

    latitude in degrees

    -
    a
    +
    a

    radius of the earth

    @@ -104,15 +106,15 @@

    Details

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/cross.html b/reference/cross.html new file mode 100644 index 00000000..b65fc5f1 --- /dev/null +++ b/reference/cross.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/cut.eof.html b/reference/cut.eof.html index 9ebb78c5..b5295b0d 100644 --- a/reference/cut.eof.html +++ b/reference/cut.eof.html @@ -3,7 +3,7 @@ - +
    - +

    Remove some principal components.

    - Source: R/EOF_methods.R + Source: R/EOF_methods.R
    @@ -66,21 +66,23 @@

    Remove some principal components.

    - 
    # S3 method for eof
+    
    # S3 method for class 'eof'
 cut(x, n, ...)

    Arguments

    -
    x
    + + +
    x

    an eof object

    -
    n
    +
    n

    which eofs to keep

    -
    ...
    +
    ...

    further arguments passed to or from other methods

    @@ -97,15 +99,15 @@

    Arguments

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/denormalise.html b/reference/denormalise.html index 37f895db..8aeedcef 100644 --- a/reference/denormalise.html +++ b/reference/denormalise.html @@ -4,7 +4,7 @@ - +
    - +

    Denormalise eof matrices

    - Source: R/EOF_methods.R + Source: R/EOF_methods.R
    @@ -75,11 +75,13 @@

    Denormalise eof matrices

    Arguments

    -
    eof
    + + +
    eof

    an eof object.

    -
    which
    +
    which

    which side of the eof decomposition to denormalise

    @@ -96,15 +98,15 @@

    Arguments

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/denormalize.html b/reference/denormalize.html new file mode 100644 index 00000000..871ec16d --- /dev/null +++ b/reference/denormalize.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/discretised_scale.html b/reference/discretised_scale.html index eb577988..9be14046 100644 --- a/reference/discretised_scale.html +++ b/reference/discretised_scale.html @@ -6,7 +6,7 @@ - +
    - +

    Create discretised versions of continuous scales

    - Source: R/as-discretised-scale.R, R/scale-unbinned.R + Source: R/as-discretised-scale.R, R/scale-unbinned.R
    @@ -116,11 +116,13 @@

    Create discretised versions of continuous scales

    Arguments

    -
    scale_function
    + + +
    scale_function

    a scale function (e.g. scale_fill_divergent)

    -
    ...
    +
    ...

    Arguments passed on to continuous_scale

    scale_name

    [Deprecated] The name of the scale that should be used for error messages associated with this scale.

    @@ -137,18 +139,19 @@

    Arguments

  • A numeric vector of positions

  • A function that takes the limits as input and returns breaks as output (e.g., a function returned by scales::extended_breaks()). +Note that for position scales, limits are provided after scale expansion. Also accepts rlang lambda function notation.

    • minor_breaks

    One of:

    • NULL for no minor breaks

      • -

    • waiver() for the default breaks (one minor break between -each major break)

      • +

    • waiver() for the default breaks (none for discrete, one minor break +between each major break for continuous)

    • A numeric vector of positions

    • A function that given the limits returns a vector of minor breaks. Also accepts rlang lambda function notation. When the function has two arguments, it will be given the limits and major -breaks.

      • +break positions.

    n.breaks
    @@ -202,92 +205,81 @@

    Arguments

    [Deprecated] Deprecated in favour of transform.

    -
    expand
    -

    For position scales, a vector of range expansion constants used to add some -padding around the data to ensure that they are placed some distance -away from the axes. Use the convenience function expansion() -to generate the values for the expand argument. The defaults are to -expand the scale by 5% on each side for continuous variables, and by -0.6 units on each side for discrete variables.

    - -
    position
    -

    For position scales, The position of the axis. -left or right for y axes, top or bottom for x axes.

    -
    call

    The call used to construct the scale for reporting messages.

    super

    The super class to use for the constructed scale

    - +
    -
    low, high
    +
    low, high

    Colours for low and high ends of the gradient.

    -
    space
    +
    space

    colour space in which to calculate gradient. Must be "Lab" - other values are deprecated.

    -
    na.value
    +
    na.value

    Colour to use for missing values

    -
    guide
    +
    guide

    Type of legend. Use "colourbar" for continuous colour bar, or "legend" for discrete colour legend.

    -
    aesthetics
    +
    aesthetics

    Character string or vector of character strings listing the name(s) of the aesthetic(s) that this scale works with. This can be useful, for example, to apply colour settings to the colour and fill aesthetics at the same time, via aesthetics = c("colour", "fill").

    -
    mid
    +
    mid

    colour for mid point

    -
    midpoint
    +
    midpoint

    The midpoint (in data value) of the diverging scale. Defaults to 0.

    -
    scale_name
    +
    scale_name

    [Deprecated] The name of the scale that should be used for error messages associated with this scale.

    -
    palette
    +
    palette

    A palette function that when called with a numeric vector with values between 0 and 1 returns the corresponding output values (e.g., scales::pal_area()).

    -
    name
    +
    name

    The name of the scale. Used as the axis or legend title. If waiver(), the default, the name of the scale is taken from the first mapping used for that aesthetic. If NULL, the legend title will be omitted.

    -
    breaks
    +
    breaks

    One of:

    • NULL for no breaks

    • waiver() for the default breaks computed by the transformation object

    • A numeric vector of positions

    • A function that takes the limits as input and returns breaks as output (e.g., a function returned by scales::extended_breaks()). +Note that for position scales, limits are provided after scale expansion. Also accepts rlang lambda function notation.

    -
    labels
    +
    labels

    One of:

    • NULL for no labels

    • waiver() for the default labels computed by the transformation object

      • @@ -299,7 +291,7 @@

      Arguments

    -
    limits
    +
    limits

    One of:

    • NULL to use the default scale range

    • A numeric vector of length two providing limits of the scale. Use NA to refer to the existing minimum or maximum

      • @@ -312,22 +304,22 @@

      Arguments

    -
    trans
    +
    trans

    [Deprecated] Deprecated in favour of transform.

    -
    drop
    +
    drop

    Should unused factor levels be omitted from the scale? The default, TRUE, uses the levels that appear in the data; FALSE uses all the levels in the factor.

    -
    position
    +
    position

    For position scales, The position of the axis. left or right for y axes, top or bottom for x axes.

    -
    rescaler
    +
    rescaler

    A function used to scale the input values to the range [0, 1]. This is always scales::rescale(), except for diverging and n colour gradients (i.e., scale_colour_gradient2(), @@ -336,7 +328,7 @@

    Arguments

    lambda function notation.

    -
    oob
    +
    oob

    One of:

    • Function that handles limits outside of the scale limits (out of bounds). Also accepts rlang lambda function notation.

      • @@ -347,15 +339,13 @@

      Arguments

    -
    super
    +
    super

    The super class to use for the constructed scale

    Value

    - - -

    A function with the same arguments as scale_function that works with discretised +

    A function with the same arguments as scale_function that works with discretised values.

    @@ -376,7 +366,6 @@

    Examples

    library(ggplot2)
 scale_fill_brewer_discretised <- as.discretised_scale(scale_fill_distiller)
 
-data.table::setDTthreads(1)
 
 library(ggplot2)
 
@@ -446,15 +435,15 @@ 
    Examples
    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/dlat.html b/reference/dlat.html new file mode 100644 index 00000000..ee3ced65 --- /dev/null +++ b/reference/dlat.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/dlon.html b/reference/dlon.html new file mode 100644 index 00000000..ee3ced65 --- /dev/null +++ b/reference/dlon.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/dx.html b/reference/dx.html new file mode 100644 index 00000000..ee3ced65 --- /dev/null +++ b/reference/dx.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/dy.html b/reference/dy.html new file mode 100644 index 00000000..ee3ced65 --- /dev/null +++ b/reference/dy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/f.dy.html b/reference/f.dy.html new file mode 100644 index 00000000..406fff23 --- /dev/null +++ b/reference/f.dy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/f.html b/reference/f.html new file mode 100644 index 00000000..406fff23 --- /dev/null +++ b/reference/f.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/geom_arrow.html b/reference/geom_arrow.html index efdf5e42..ca027272 100644 --- a/reference/geom_arrow.html +++ b/reference/geom_arrow.html @@ -6,7 +6,7 @@ - +
    - +

    Arrows

    - Source: R/geom_arrow.R + Source: R/geom_arrow.R
    @@ -127,14 +127,16 @@

    Arrows

    Arguments

    -
    mapping
    + + +
    mapping

    Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

    -
    data
    +
    data

    The data to be displayed in this layer. There are three options:

    If NULL, the default, the data is inherited from the plot @@ -148,72 +150,105 @@

    Arguments

    from a formula (e.g. ~ head(.x, 10)).

    -
    stat
    -

    The statistical transformation to use on the data for this -layer, either as a ggproto Geom subclass or as a string naming the -stat stripped of the stat_ prefix (e.g. "count" rather than -"stat_count")

    - - -
    position
    -

    Position adjustment, either as a string naming the adjustment -(e.g. "jitter" to use position_jitter), or the result of a call to a -position adjustment function. Use the latter if you need to change the -settings of the adjustment.

    - - -
    ...
    -

    Other arguments passed on to layer(). These are -often aesthetics, used to set an aesthetic to a fixed value, like -colour = "red" or size = 3. They may also be parameters -to the paired geom/stat.

    - - -
    start
    +
    stat
    +

    The statistical transformation to use on the data for this layer. +When using a geom_*() function to construct a layer, the stat +argument can be used the override the default coupling between geoms and +stats. The stat argument accepts the following:

    • A Stat ggproto subclass, for example StatCount.

      • +

    • A string naming the stat. To give the stat as a string, strip the +function name of the stat_ prefix. For example, to use stat_count(), +give the stat as "count".

      • +

    • For more information and other ways to specify the stat, see the +layer stat documentation.

      • +
    + + +
    position
    +

    A position adjustment to use on the data for this layer. This +can be used in various ways, including to prevent overplotting and +improving the display. The position argument accepts the following:

    • The result of calling a position function, such as position_jitter(). +This method allows for passing extra arguments to the position.

      • +

    • A string naming the position adjustment. To give the position as a +string, strip the function name of the position_ prefix. For example, +to use position_jitter(), give the position as "jitter".

      • +

    • For more information and other ways to specify the position, see the +layer position documentation.

      • +
    + + +
    ...
    +

    Other arguments passed on to layer()'s params argument. These +arguments broadly fall into one of 4 categories below. Notably, further +arguments to the position argument, or aesthetics that are required +can not be passed through .... Unknown arguments that are not part +of the 4 categories below are ignored.

    • Static aesthetics that are not mapped to a scale, but are at a fixed +value and apply to the layer as a whole. For example, colour = "red" +or linewidth = 3. The geom's documentation has an Aesthetics +section that lists the available options. The 'required' aesthetics +cannot be passed on to the params. Please note that while passing +unmapped aesthetics as vectors is technically possible, the order and +required length is not guaranteed to be parallel to the input data.

      • +

    • When constructing a layer using +a stat_*() function, the ... argument can be used to pass on +parameters to the geom part of the layer. An example of this is +stat_density(geom = "area", outline.type = "both"). The geom's +documentation lists which parameters it can accept.

      • +

    • Inversely, when constructing a layer using a +geom_*() function, the ... argument can be used to pass on parameters +to the stat part of the layer. An example of this is +geom_area(stat = "density", adjust = 0.5). The stat's documentation +lists which parameters it can accept.

      • +

    • The key_glyph argument of layer() may also be passed on through +.... This can be one of the functions described as +key glyphs, to change the display of the layer in the legend.

      • +
    + + +
    start

    starting angle for rotation in degrees

    -
    direction
    +
    direction

    direction of rotation (counter-clockwise or clockwise)

    -
    pivot
    +
    pivot

    numeric indicating where to pivot the arrow where 0 means at the beginning and 1 means at the end.

    -
    preserve.dir
    +
    preserve.dir

    logical indicating whether to preserve direction or not

    -
    min.mag
    +
    min.mag

    minimum magnitude for plotting vectors

    -
    skip, skip.x, skip.y
    +
    skip, skip.x, skip.y

    numeric specifying number of gridpoints not to draw in the x and y direction

    -
    arrow.length, arrow.angle, arrow.ends, arrow.type
    +
    arrow.length, arrow.angle, arrow.ends, arrow.type

    parameters passed to grid::arrow

    -
    arrow
    +
    arrow

    specification for arrow heads, as created by grid::arrow().

    -
    lineend
    +
    lineend

    Line end style (round, butt, square).

    -
    na.rm
    +
    na.rm

    If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

    -
    show.legend
    +
    show.legend

    logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. @@ -221,7 +256,7 @@

    Arguments

    display.

    -
    inherit.aes
    +
    inherit.aes

    If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from @@ -235,7 +270,7 @@

    Details

    Aesthetics

    - +

    geom_vector understands the following aesthetics (required aesthetics are in bold)

    • x

      • @@ -249,7 +284,7 @@

      Aesthetics

    See also

    -

    Other ggplot2 helpers: +

    Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_contour2(), @@ -401,15 +436,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/geom_contour2.html b/reference/geom_contour2.html index 36aeed66..3cfddfb5 100644 --- a/reference/geom_contour2.html +++ b/reference/geom_contour2.html @@ -5,7 +5,7 @@ - +
    - +

    2d contours of a 3d surface

    - Source: R/geom_contour2.r, R/stat_contour2.r + Source: R/geom_contour2.r, R/stat_contour2.r
    @@ -102,6 +102,7 @@

    2d contours of a 3d surface

    bins = NULL, binwidth = NULL, proj = NULL, + proj.latlon = TRUE, clip = NULL, kriging = FALSE, global.breaks = TRUE, @@ -114,14 +115,16 @@

    2d contours of a 3d surface

    Arguments

    -
    mapping
    + + +
    mapping

    Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

    -
    data
    +
    data

    The data to be displayed in this layer. There are three options:

    If NULL, the default, the data is inherited from the plot @@ -135,65 +138,98 @@

    Arguments

    from a formula (e.g. ~ head(.x, 10)).

    -
    stat
    -

    The statistical transformation to use on the data for this -layer, either as a ggproto Geom subclass or as a string naming the -stat stripped of the stat_ prefix (e.g. "count" rather than -"stat_count")

    +
    stat
    +

    The statistical transformation to use on the data for this layer. +When using a geom_*() function to construct a layer, the stat +argument can be used the override the default coupling between geoms and +stats. The stat argument accepts the following:

    • A Stat ggproto subclass, for example StatCount.

      • +

    • A string naming the stat. To give the stat as a string, strip the +function name of the stat_ prefix. For example, to use stat_count(), +give the stat as "count".

      • +

    • For more information and other ways to specify the stat, see the +layer stat documentation.

      • +
    -
    position
    -

    Position adjustment, either as a string naming the adjustment -(e.g. "jitter" to use position_jitter), or the result of a call to a -position adjustment function. Use the latter if you need to change the -settings of the adjustment.

    +
    position
    +

    A position adjustment to use on the data for this layer. This +can be used in various ways, including to prevent overplotting and +improving the display. The position argument accepts the following:

    • The result of calling a position function, such as position_jitter(). +This method allows for passing extra arguments to the position.

      • +

    • A string naming the position adjustment. To give the position as a +string, strip the function name of the position_ prefix. For example, +to use position_jitter(), give the position as "jitter".

      • +

    • For more information and other ways to specify the position, see the +layer position documentation.

      • +
    -
    ...
    -

    Other arguments passed on to layer(). These are -often aesthetics, used to set an aesthetic to a fixed value, like -colour = "red" or size = 3. They may also be parameters -to the paired geom/stat.

    +
    ...
    +

    Other arguments passed on to layer()'s params argument. These +arguments broadly fall into one of 4 categories below. Notably, further +arguments to the position argument, or aesthetics that are required +can not be passed through .... Unknown arguments that are not part +of the 4 categories below are ignored.

    • Static aesthetics that are not mapped to a scale, but are at a fixed +value and apply to the layer as a whole. For example, colour = "red" +or linewidth = 3. The geom's documentation has an Aesthetics +section that lists the available options. The 'required' aesthetics +cannot be passed on to the params. Please note that while passing +unmapped aesthetics as vectors is technically possible, the order and +required length is not guaranteed to be parallel to the input data.

      • +

    • When constructing a layer using +a stat_*() function, the ... argument can be used to pass on +parameters to the geom part of the layer. An example of this is +stat_density(geom = "area", outline.type = "both"). The geom's +documentation lists which parameters it can accept.

      • +

    • Inversely, when constructing a layer using a +geom_*() function, the ... argument can be used to pass on parameters +to the stat part of the layer. An example of this is +geom_area(stat = "density", adjust = 0.5). The stat's documentation +lists which parameters it can accept.

      • +

    • The key_glyph argument of layer() may also be passed on through +.... This can be one of the functions described as +key glyphs, to change the display of the layer in the legend.

      • +
    -
    lineend
    +
    lineend

    Line end style (round, butt, square).

    -
    linejoin
    +
    linejoin

    Line join style (round, mitre, bevel).

    -
    linemitre
    +
    linemitre

    Line mitre limit (number greater than 1).

    -
    breaks
    +
    breaks

    One of:

    • A numeric vector of breaks

    • A function that takes the range of the data and binwidth as input and returns breaks as output

    -
    bins
    +
    bins

    Number of evenly spaced breaks.

    -
    binwidth
    +
    binwidth

    Distance between breaks.

    -
    global.breaks
    +
    global.breaks

    Logical indicating whether breaks should be computed for the whole data or for each grouping.

    -
    na.rm
    +
    na.rm

    If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

    -
    na.fill
    +
    na.fill

    How to fill missing values.

    • FALSE for letting the computation fail with no interpolation

    • TRUE for imputing missing values with Impute2D

    • A numeric value for constant imputation

      • @@ -201,21 +237,21 @@

      Arguments

    -
    skip
    +
    skip

    number of contours to skip for labelling (e.g. skip = 1 will skip 1 contour line between labels).

    -
    margin
    +
    margin

    the margin around labels around which contour lines are clipped to avoid overlapping.

    -
    label.placer
    +
    label.placer

    a label placer function. See label_placer_flattest().

    -
    show.legend
    +
    show.legend

    logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. @@ -223,31 +259,43 @@

    Arguments

    display.

    -
    inherit.aes
    +
    inherit.aes

    If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().

    -
    geom
    -

    The geometric object to use to display the data, either as a -ggproto Geom subclass or as a string naming the geom stripped of the -geom_ prefix (e.g. "point" rather than "geom_point")

    +
    geom
    +

    The geometric object to use to display the data for this layer. +When using a stat_*() function to construct a layer, the geom argument +can be used to override the default coupling between stats and geoms. The +geom argument accepts the following:

    • A Geom ggproto subclass, for example GeomPoint.

      • +

    • A string naming the geom. To give the geom as a string, strip the +function name of the geom_ prefix. For example, to use geom_point(), +give the geom as "point".

      • +

    • For more information and other ways to specify the geom, see the +layer geom documentation.

      • +
    -
    proj
    +
    proj

    The projection to which to project the contours to. It can be either a projection string or a function to apply to the whole contour dataset.

    -
    clip
    +
    proj.latlon
    +

    Logical indicating if the projection step should project +from a cartographic projection to a lon/lat grid or the other way around.

    + + +
    clip

    A simple features object to be used as a clip. Contours are only drawn in the interior of this polygon.

    -
    kriging
    +
    kriging

    Whether to perform ordinary kriging before contouring. Use this if you want to use contours with irregularly spaced data. If FALSE, no kriging is performed. If TRUE, kriging will be performed with @@ -256,7 +304,7 @@

    Arguments

    Aesthetics

    - +

    geom_contour2 understands the following aesthetics (required aesthetics are in bold):

    Aesthetics related to contour lines:

    • x

      • @@ -277,7 +325,7 @@

      Aesthetics

    Computed variables

    - +
    level

    height of contour

    @@ -286,7 +334,7 @@

    Computed variables

    See also

    -

    Other ggplot2 helpers: +

    Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -301,7 +349,7 @@

    See also

    scale_longitude, stat_na(), stat_subset()

    -

    Other ggplot2 helpers: +

    Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -320,8 +368,7 @@

    See also

    Examples

    - 
    data.table::setDTthreads(1)
-
+    
    
 library(ggplot2)
 
 # Breaks can be a function.
@@ -368,15 +415,15 @@ 
    Examples
    
 
    
 
 
    
-  
    Site built with pkgdown 2.0.9.
    
+  
    Site built with pkgdown 2.1.0.
    - - + + diff --git a/reference/geom_contour_fill.html b/reference/geom_contour_fill.html index be0f5a78..28e892ef 100644 --- a/reference/geom_contour_fill.html +++ b/reference/geom_contour_fill.html @@ -10,7 +10,7 @@ - +
    - +

    Filled 2d contours of a 3d surface

    - Source: R/geom_contour_fill.R, R/stat_contour_fill.R + Source: R/geom_contour_fill.R, R/stat_contour_fill.R
    @@ -109,6 +109,7 @@

    Filled 2d contours of a 3d surface

    binwidth = NULL, global.breaks = TRUE, proj = NULL, + proj.latlon = TRUE, clip = NULL, kriging = FALSE, na.fill = FALSE, @@ -119,14 +120,16 @@

    Filled 2d contours of a 3d surface

    Arguments

    -
    mapping
    + + +
    mapping

    Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

    -
    data
    +
    data

    The data to be displayed in this layer. There are three options:

    If NULL, the default, the data is inherited from the plot @@ -140,63 +143,96 @@

    Arguments

    from a formula (e.g. ~ head(.x, 10)).

    -
    stat
    -

    The statistical transformation to use on the data for this -layer, either as a ggproto Geom subclass or as a string naming the -stat stripped of the stat_ prefix (e.g. "count" rather than -"stat_count")

    +
    stat
    +

    The statistical transformation to use on the data for this layer. +When using a geom_*() function to construct a layer, the stat +argument can be used the override the default coupling between geoms and +stats. The stat argument accepts the following:

    • A Stat ggproto subclass, for example StatCount.

      • +

    • A string naming the stat. To give the stat as a string, strip the +function name of the stat_ prefix. For example, to use stat_count(), +give the stat as "count".

      • +

    • For more information and other ways to specify the stat, see the +layer stat documentation.

      • +
    -
    position
    -

    Position adjustment, either as a string naming the adjustment -(e.g. "jitter" to use position_jitter), or the result of a call to a -position adjustment function. Use the latter if you need to change the -settings of the adjustment.

    +
    position
    +

    A position adjustment to use on the data for this layer. This +can be used in various ways, including to prevent overplotting and +improving the display. The position argument accepts the following:

    • The result of calling a position function, such as position_jitter(). +This method allows for passing extra arguments to the position.

      • +

    • A string naming the position adjustment. To give the position as a +string, strip the function name of the position_ prefix. For example, +to use position_jitter(), give the position as "jitter".

      • +

    • For more information and other ways to specify the position, see the +layer position documentation.

      • +
    -
    ...
    -

    Other arguments passed on to layer(). These are -often aesthetics, used to set an aesthetic to a fixed value, like -colour = "red" or size = 3. They may also be parameters -to the paired geom/stat.

    +
    ...
    +

    Other arguments passed on to layer()'s params argument. These +arguments broadly fall into one of 4 categories below. Notably, further +arguments to the position argument, or aesthetics that are required +can not be passed through .... Unknown arguments that are not part +of the 4 categories below are ignored.

    • Static aesthetics that are not mapped to a scale, but are at a fixed +value and apply to the layer as a whole. For example, colour = "red" +or linewidth = 3. The geom's documentation has an Aesthetics +section that lists the available options. The 'required' aesthetics +cannot be passed on to the params. Please note that while passing +unmapped aesthetics as vectors is technically possible, the order and +required length is not guaranteed to be parallel to the input data.

      • +

    • When constructing a layer using +a stat_*() function, the ... argument can be used to pass on +parameters to the geom part of the layer. An example of this is +stat_density(geom = "area", outline.type = "both"). The geom's +documentation lists which parameters it can accept.

      • +

    • Inversely, when constructing a layer using a +geom_*() function, the ... argument can be used to pass on parameters +to the stat part of the layer. An example of this is +geom_area(stat = "density", adjust = 0.5). The stat's documentation +lists which parameters it can accept.

      • +

    • The key_glyph argument of layer() may also be passed on through +.... This can be one of the functions described as +key glyphs, to change the display of the layer in the legend.

      • +
    -
    breaks
    +
    breaks

    numeric vector of breaks

    -
    bins
    +
    bins

    Number of evenly spaced breaks.

    -
    binwidth
    +
    binwidth

    Distance between breaks.

    -
    proj
    +
    proj

    The projection to which to project the contours to. It can be either a projection string or a function to apply to the whole contour dataset.

    -
    clip
    +
    clip

    A simple features object to be used as a clip. Contours are only drawn in the interior of this polygon.

    -
    kriging
    +
    kriging

    Whether to perform ordinary kriging before contouring. Use this if you want to use contours with irregularly spaced data. If FALSE, no kriging is performed. If TRUE, kriging will be performed with 40 points. If a numeric, kriging will be performed with kriging points.

    -
    global.breaks
    +
    global.breaks

    Logical indicating whether breaks should be computed for the whole data or for each grouping.

    -
    na.fill
    +
    na.fill

    How to fill missing values.

    • FALSE for letting the computation fail with no interpolation

    • TRUE for imputing missing values with Impute2D

    • A numeric value for constant imputation

      • @@ -204,7 +240,7 @@

      Arguments

    -
    show.legend
    +
    show.legend

    logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. @@ -212,22 +248,34 @@

    Arguments

    display.

    -
    inherit.aes
    +
    inherit.aes

    If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().

    -
    geom
    -

    The geometric object to use to display the data, either as a -ggproto Geom subclass or as a string naming the geom stripped of the -geom_ prefix (e.g. "point" rather than "geom_point")

    +
    geom
    +

    The geometric object to use to display the data for this layer. +When using a stat_*() function to construct a layer, the geom argument +can be used to override the default coupling between stats and geoms. The +geom argument accepts the following:

    • A Geom ggproto subclass, for example GeomPoint.

      • +

    • A string naming the geom. To give the geom as a string, strip the +function name of the geom_ prefix. For example, to use geom_point(), +give the geom as "point".

      • +

    • For more information and other ways to specify the geom, see the +layer geom documentation.

      • +
    + + +
    proj.latlon
    +

    Logical indicating if the projection step should project +from a cartographic projection to a lon/lat grid or the other way around.

    Aesthetics

    - +

    geom_contour_fill understands the following aesthetics (required aesthetics are in bold):

    • x

      • @@ -241,7 +289,7 @@

      Aesthetics

    Computed variables

    - +
    level

    An ordered factor that represents bin ranges.

    @@ -256,7 +304,7 @@

    Computed variables

    See also

    -

    Other ggplot2 helpers: +

    Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -275,8 +323,7 @@

    See also

    Examples

    - 
    data.table::setDTthreads(1)
-
+    
    
 library(ggplot2)
 surface <- reshape2::melt(volcano)
 ggplot(surface, aes(Var1, Var2, z = value)) +
@@ -308,15 +355,15 @@ 
    Examples
    
 
    
 
 
    
-  
    Site built with pkgdown 2.0.9.
    
+  
    Site built with pkgdown 2.1.0.
    - - + + diff --git a/reference/geom_contour_tanaka.html b/reference/geom_contour_tanaka.html index 58ffb159..c353c8af 100644 --- a/reference/geom_contour_tanaka.html +++ b/reference/geom_contour_tanaka.html @@ -7,7 +7,7 @@ - +
    - +

    Illuminated contours

    - Source: R/geom_contour_tanaka.R + Source: R/geom_contour_tanaka.R
    @@ -89,6 +89,7 @@

    Illuminated contours

    range = c(0.01, 0.5), smooth = 0, proj = NULL, + proj.latlon = TRUE, clip = NULL, kriging = FALSE, na.rm = FALSE, @@ -99,14 +100,16 @@

    Illuminated contours

    Arguments

    -
    mapping
    + + +
    mapping

    Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

    -
    data
    +
    data

    The data to be displayed in this layer. There are three options:

    If NULL, the default, the data is inherited from the plot @@ -120,83 +123,121 @@

    Arguments

    from a formula (e.g. ~ head(.x, 10)).

    -
    stat
    -

    The statistical transformation to use on the data for this -layer, either as a ggproto Geom subclass or as a string naming the -stat stripped of the stat_ prefix (e.g. "count" rather than -"stat_count")

    +
    stat
    +

    The statistical transformation to use on the data for this layer. +When using a geom_*() function to construct a layer, the stat +argument can be used the override the default coupling between geoms and +stats. The stat argument accepts the following:

    • A Stat ggproto subclass, for example StatCount.

      • +

    • A string naming the stat. To give the stat as a string, strip the +function name of the stat_ prefix. For example, to use stat_count(), +give the stat as "count".

      • +

    • For more information and other ways to specify the stat, see the +layer stat documentation.

      • +
    -
    position
    -

    Position adjustment, either as a string naming the adjustment -(e.g. "jitter" to use position_jitter), or the result of a call to a -position adjustment function. Use the latter if you need to change the -settings of the adjustment.

    +
    position
    +

    A position adjustment to use on the data for this layer. This +can be used in various ways, including to prevent overplotting and +improving the display. The position argument accepts the following:

    • The result of calling a position function, such as position_jitter(). +This method allows for passing extra arguments to the position.

      • +

    • A string naming the position adjustment. To give the position as a +string, strip the function name of the position_ prefix. For example, +to use position_jitter(), give the position as "jitter".

      • +

    • For more information and other ways to specify the position, see the +layer position documentation.

      • +
    -
    ...
    -

    Other arguments passed on to layer(). These are -often aesthetics, used to set an aesthetic to a fixed value, like -colour = "red" or size = 3. They may also be parameters -to the paired geom/stat.

    +
    ...
    +

    Other arguments passed on to layer()'s params argument. These +arguments broadly fall into one of 4 categories below. Notably, further +arguments to the position argument, or aesthetics that are required +can not be passed through .... Unknown arguments that are not part +of the 4 categories below are ignored.

    • Static aesthetics that are not mapped to a scale, but are at a fixed +value and apply to the layer as a whole. For example, colour = "red" +or linewidth = 3. The geom's documentation has an Aesthetics +section that lists the available options. The 'required' aesthetics +cannot be passed on to the params. Please note that while passing +unmapped aesthetics as vectors is technically possible, the order and +required length is not guaranteed to be parallel to the input data.

      • +

    • When constructing a layer using +a stat_*() function, the ... argument can be used to pass on +parameters to the geom part of the layer. An example of this is +stat_density(geom = "area", outline.type = "both"). The geom's +documentation lists which parameters it can accept.

      • +

    • Inversely, when constructing a layer using a +geom_*() function, the ... argument can be used to pass on parameters +to the stat part of the layer. An example of this is +geom_area(stat = "density", adjust = 0.5). The stat's documentation +lists which parameters it can accept.

      • +

    • The key_glyph argument of layer() may also be passed on through +.... This can be one of the functions described as +key glyphs, to change the display of the layer in the legend.

      • +
    -
    breaks
    +
    breaks

    One of:

    • A numeric vector of breaks

    • A function that takes the range of the data and binwidth as input and returns breaks as output

    -
    bins
    +
    bins

    Number of evenly spaced breaks.

    -
    binwidth
    +
    binwidth

    Distance between breaks.

    -
    sun.angle
    +
    sun.angle

    angle of the sun in degrees counterclockwise from 12 o' clock

    -
    light, dark
    +
    light, dark

    valid colour representing the light and dark shading

    -
    range
    +
    range

    numeric vector of length 2 with the minimum and maximum size of lines

    -
    smooth
    +
    smooth

    numeric indicating the degree of smoothing of illumination and size. Larger

    -
    proj
    +
    proj

    The projection to which to project the contours to. It can be either a projection string or a function to apply to the whole contour dataset.

    -
    clip
    +
    proj.latlon
    +

    Logical indicating if the projection step should project +from a cartographic projection to a lon/lat grid or the other way around.

    + + +
    clip

    A simple features object to be used as a clip. Contours are only drawn in the interior of this polygon.

    -
    kriging
    +
    kriging

    Whether to perform ordinary kriging before contouring. Use this if you want to use contours with irregularly spaced data. If FALSE, no kriging is performed. If TRUE, kriging will be performed with 40 points. If a numeric, kriging will be performed with kriging points.

    -
    na.rm
    +
    na.rm

    If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

    -
    show.legend
    +
    show.legend

    logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. @@ -204,7 +245,7 @@

    Arguments

    display.

    -
    inherit.aes
    +
    inherit.aes

    If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from @@ -213,7 +254,7 @@

    Arguments

    Aesthetics

    - +

    geom_contour_tanaka understands the following aesthetics (required aesthetics are in bold)

    • x

      • @@ -224,8 +265,7 @@

      Aesthetics

      Examples

      - 
      data.table::setDTthreads(1)
-
+    
      
 library(ggplot2)
 library(data.table)
 # A fresh look at the boring old volcano dataset
@@ -303,15 +343,15 @@ 
      Examples
      
 
      
 
 
      
-  
      Site built with pkgdown 2.0.9.
      
+  
      Site built with pkgdown 2.1.0.
      - - + + diff --git a/reference/geom_relief.html b/reference/geom_relief.html index 57d0ba79..f9e5c2c1 100644 --- a/reference/geom_relief.html +++ b/reference/geom_relief.html @@ -6,7 +6,7 @@ - +
      - +

      Relief Shading

      - Source: R/geom_relief.R, R/geom_shadow.R + Source: R/geom_relief.R, R/geom_shadow.R
      @@ -106,14 +106,16 @@

      Relief Shading

      Arguments

      -
      mapping
      + + +
      mapping

      Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

      -
      data
      +
      data

      The data to be displayed in this layer. There are three options:

      If NULL, the default, the data is inherited from the plot @@ -127,52 +129,85 @@

      Arguments

      from a formula (e.g. ~ head(.x, 10)).

      -
      stat
      -

      The statistical transformation to use on the data for this -layer, either as a ggproto Geom subclass or as a string naming the -stat stripped of the stat_ prefix (e.g. "count" rather than -"stat_count")

      - - -
      position
      -

      Position adjustment, either as a string naming the adjustment -(e.g. "jitter" to use position_jitter), or the result of a call to a -position adjustment function. Use the latter if you need to change the -settings of the adjustment.

      - - -
      ...
      -

      Other arguments passed on to layer(). These are -often aesthetics, used to set an aesthetic to a fixed value, like -colour = "red" or size = 3. They may also be parameters -to the paired geom/stat.

      - - -
      sun.angle
      +
      stat
      +

      The statistical transformation to use on the data for this layer. +When using a geom_*() function to construct a layer, the stat +argument can be used the override the default coupling between geoms and +stats. The stat argument accepts the following:

      • A Stat ggproto subclass, for example StatCount.

        • +

      • A string naming the stat. To give the stat as a string, strip the +function name of the stat_ prefix. For example, to use stat_count(), +give the stat as "count".

        • +

      • For more information and other ways to specify the stat, see the +layer stat documentation.

        • +
      + + +
      position
      +

      A position adjustment to use on the data for this layer. This +can be used in various ways, including to prevent overplotting and +improving the display. The position argument accepts the following:

      • The result of calling a position function, such as position_jitter(). +This method allows for passing extra arguments to the position.

        • +

      • A string naming the position adjustment. To give the position as a +string, strip the function name of the position_ prefix. For example, +to use position_jitter(), give the position as "jitter".

        • +

      • For more information and other ways to specify the position, see the +layer position documentation.

        • +
      + + +
      ...
      +

      Other arguments passed on to layer()'s params argument. These +arguments broadly fall into one of 4 categories below. Notably, further +arguments to the position argument, or aesthetics that are required +can not be passed through .... Unknown arguments that are not part +of the 4 categories below are ignored.

      • Static aesthetics that are not mapped to a scale, but are at a fixed +value and apply to the layer as a whole. For example, colour = "red" +or linewidth = 3. The geom's documentation has an Aesthetics +section that lists the available options. The 'required' aesthetics +cannot be passed on to the params. Please note that while passing +unmapped aesthetics as vectors is technically possible, the order and +required length is not guaranteed to be parallel to the input data.

        • +

      • When constructing a layer using +a stat_*() function, the ... argument can be used to pass on +parameters to the geom part of the layer. An example of this is +stat_density(geom = "area", outline.type = "both"). The geom's +documentation lists which parameters it can accept.

        • +

      • Inversely, when constructing a layer using a +geom_*() function, the ... argument can be used to pass on parameters +to the stat part of the layer. An example of this is +geom_area(stat = "density", adjust = 0.5). The stat's documentation +lists which parameters it can accept.

        • +

      • The key_glyph argument of layer() may also be passed on through +.... This can be one of the functions described as +key glyphs, to change the display of the layer in the legend.

        • +
      + + +
      sun.angle

      angle from which the sun is shining, in degrees counterclockwise from 12 o' clock

      -
      raster
      +
      raster

      if TRUE (the default), uses ggplot2::geom_raster, if FALSE, uses ggplot2::geom_tile.

      -
      interpolate
      +
      interpolate

      If TRUE interpolate linearly, if FALSE (the default) don't interpolate.

      -
      shadow
      +
      shadow

      if TRUE, adds also a layer of geom_shadow()

      -
      na.rm
      +
      na.rm

      If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

      -
      show.legend
      +
      show.legend

      logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. @@ -180,18 +215,18 @@

      Arguments

      display.

      -
      inherit.aes
      +
      inherit.aes

      If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().

      -
      range
      +
      range

      transparency range for shadows

      -
      skip
      +
      skip

      data points to skip when casting shadows

      @@ -202,7 +237,7 @@

      Details

      Aesthetics

      - +

      geom_relief() and geom_shadow() understands the following aesthetics (required aesthetics are in bold)

      • x

        • @@ -214,7 +249,7 @@

        Aesthetics

      See also

      -

      Other ggplot2 helpers: +

      Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -233,11 +268,11 @@

      See also

      Examples

      - 
      if (FALSE) {
+    
      if (FALSE) { # \dontrun{
 library(ggplot2)
 ggplot(reshape2::melt(volcano), aes(Var1, Var2)) +
       geom_relief(aes(z = value))
-}
+} # }
      @@ -252,15 +287,15 @@

      Examples

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/geom_shadow.html b/reference/geom_shadow.html new file mode 100644 index 00000000..34a9761e --- /dev/null +++ b/reference/geom_shadow.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/geom_streamline.html b/reference/geom_streamline.html index 10c82c9e..1d021a1b 100644 --- a/reference/geom_streamline.html +++ b/reference/geom_streamline.html @@ -5,7 +5,7 @@ - +
      - +

      Streamlines

      - Source: R/geom_streamline.R + Source: R/geom_streamline.R
      @@ -141,14 +141,16 @@

      Streamlines

      Arguments

      -
      mapping
      + + +
      mapping

      Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

      -
      data
      +
      data

      The data to be displayed in this layer. There are three options:

      If NULL, the default, the data is inherited from the plot @@ -162,84 +164,117 @@

      Arguments

      from a formula (e.g. ~ head(.x, 10)).

      -
      stat
      -

      The statistical transformation to use on the data for this -layer, either as a ggproto Geom subclass or as a string naming the -stat stripped of the stat_ prefix (e.g. "count" rather than -"stat_count")

      - - -
      position
      -

      Position adjustment, either as a string naming the adjustment -(e.g. "jitter" to use position_jitter), or the result of a call to a -position adjustment function. Use the latter if you need to change the -settings of the adjustment.

      - - -
      ...
      -

      Other arguments passed on to layer(). These are -often aesthetics, used to set an aesthetic to a fixed value, like -colour = "red" or size = 3. They may also be parameters -to the paired geom/stat.

      - - -
      L,
      +
      stat
      +

      The statistical transformation to use on the data for this layer. +When using a geom_*() function to construct a layer, the stat +argument can be used the override the default coupling between geoms and +stats. The stat argument accepts the following:

      • A Stat ggproto subclass, for example StatCount.

        • +

      • A string naming the stat. To give the stat as a string, strip the +function name of the stat_ prefix. For example, to use stat_count(), +give the stat as "count".

        • +

      • For more information and other ways to specify the stat, see the +layer stat documentation.

        • +
      + + +
      position
      +

      A position adjustment to use on the data for this layer. This +can be used in various ways, including to prevent overplotting and +improving the display. The position argument accepts the following:

      • The result of calling a position function, such as position_jitter(). +This method allows for passing extra arguments to the position.

        • +

      • A string naming the position adjustment. To give the position as a +string, strip the function name of the position_ prefix. For example, +to use position_jitter(), give the position as "jitter".

        • +

      • For more information and other ways to specify the position, see the +layer position documentation.

        • +
      + + +
      ...
      +

      Other arguments passed on to layer()'s params argument. These +arguments broadly fall into one of 4 categories below. Notably, further +arguments to the position argument, or aesthetics that are required +can not be passed through .... Unknown arguments that are not part +of the 4 categories below are ignored.

      • Static aesthetics that are not mapped to a scale, but are at a fixed +value and apply to the layer as a whole. For example, colour = "red" +or linewidth = 3. The geom's documentation has an Aesthetics +section that lists the available options. The 'required' aesthetics +cannot be passed on to the params. Please note that while passing +unmapped aesthetics as vectors is technically possible, the order and +required length is not guaranteed to be parallel to the input data.

        • +

      • When constructing a layer using +a stat_*() function, the ... argument can be used to pass on +parameters to the geom part of the layer. An example of this is +stat_density(geom = "area", outline.type = "both"). The geom's +documentation lists which parameters it can accept.

        • +

      • Inversely, when constructing a layer using a +geom_*() function, the ... argument can be used to pass on parameters +to the stat part of the layer. An example of this is +geom_area(stat = "density", adjust = 0.5). The stat's documentation +lists which parameters it can accept.

        • +

      • The key_glyph argument of layer() may also be passed on through +.... This can be one of the functions described as +key glyphs, to change the display of the layer in the legend.

        • +
      + + +
      L,

      typical length of a streamline in x and y units

      -
      min.L
      +
      min.L

      minimum length of segments to show

      -
      res,
      +
      res,

      resolution parameter (higher numbers increases the resolution)

      -
      S
      +
      S

      optional numeric number of timesteps for integration

      -
      dt
      +
      dt

      optional numeric size "timestep" for integration

      -
      xwrap, ywrap
      +
      xwrap, ywrap

      vector of length two used to wrap the circular dimension.

      -
      skip, skip.x, skip.y
      +
      skip, skip.x, skip.y

      numeric specifying number of gridpoints not to draw in the x and y direction

      -
      n, nx, ny
      +
      n, nx, ny

      optional numeric indicating the number of points to draw in the x and y direction (replaces skip if not NULL)

      -
      jitter, jitter.x, jitter.y
      +
      jitter, jitter.x, jitter.y

      amount of jitter of the starting points

      -
      arrow.length, arrow.angle, arrow.ends, arrow.type
      +
      arrow.length, arrow.angle, arrow.ends, arrow.type

      parameters passed to grid::arrow

      -
      arrow
      +
      arrow

      specification for arrow heads, as created by grid::arrow().

      -
      lineend
      +
      lineend

      Line end style (round, butt, square).

      -
      na.rm
      +
      na.rm

      If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

      -
      show.legend
      +
      show.legend

      logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. @@ -247,17 +282,24 @@

      Arguments

      display.

      -
      inherit.aes
      +
      inherit.aes

      If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().

      -
      geom
      -

      The geometric object to use to display the data, either as a -ggproto Geom subclass or as a string naming the geom stripped of the -geom_ prefix (e.g. "point" rather than "geom_point")

      +
      geom
      +

      The geometric object to use to display the data for this layer. +When using a stat_*() function to construct a layer, the geom argument +can be used to override the default coupling between stats and geoms. The +geom argument accepts the following:

      • A Geom ggproto subclass, for example GeomPoint.

        • +

      • A string naming the geom. To give the geom as a string, strip the +function name of the geom_ prefix. For example, to use geom_point(), +give the geom as "point".

        • +

      • For more information and other ways to specify the geom, see the +layer geom documentation.

        • +
      @@ -286,7 +328,7 @@

      Details

      Aesthetics

      - +

      stat_streamline understands the following aesthetics (required aesthetics are in bold)

      • x

        • @@ -300,7 +342,7 @@

        Aesthetics

      Computed variables

      - +
      step

      step in the simulation

      @@ -315,7 +357,7 @@

      Computed variables

      See also

      -

      Other ggplot2 helpers: +

      Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -334,7 +376,7 @@

      See also

      Examples

      - 
      if (FALSE) {
+    
      if (FALSE) { # \dontrun{
 library(data.table)
 library(ggplot2)
 data(geopotential)
@@ -382,7 +424,7 @@ 
      Examples
      
     geom_streamline(aes(dx = -dx, dy = -dy), L = 10, skip = 3, arrow = NULL,
                     color = "#4658BD") +
     coord_quickmap()
- }
+ } # }
      @@ -398,15 +440,15 @@

      Examples

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/geom_text_contour.html b/reference/geom_text_contour.html index 0cb26a5b..3198c415 100644 --- a/reference/geom_text_contour.html +++ b/reference/geom_text_contour.html @@ -3,7 +3,7 @@ - +
      - +

      Label contours

      - Source: R/geom_label_contour.R, R/geom_text_contour.R, R/stat_contour2.r + Source: R/geom_label_contour.R, R/geom_text_contour.R, R/stat_contour2.r
      @@ -109,14 +109,16 @@

      Label contours

      Arguments

      -
      mapping
      + + +
      mapping

      Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

      -
      data
      +
      data

      The data to be displayed in this layer. There are three options:

      If NULL, the default, the data is inherited from the plot @@ -130,67 +132,101 @@

      Arguments

      from a formula (e.g. ~ head(.x, 10)).

      -
      stat
      -

      The statistical transformation to use on the data for this -layer, either as a ggproto Geom subclass or as a string naming the -stat stripped of the stat_ prefix (e.g. "count" rather than -"stat_count")

      - - -
      position
      -

      Position adjustment, either as a string, or the result of -a call to a position adjustment function. Cannot be jointly specified with -nudge_x or nudge_y.

      - - -
      ...
      -

      Other arguments passed on to layer(). These are -often aesthetics, used to set an aesthetic to a fixed value, like -colour = "red" or size = 3. They may also be parameters -to the paired geom/stat.

      - - -
      min.size
      +
      stat
      +

      The statistical transformation to use on the data for this layer. +When using a geom_*() function to construct a layer, the stat +argument can be used the override the default coupling between geoms and +stats. The stat argument accepts the following:

      • A Stat ggproto subclass, for example StatCount.

        • +

      • A string naming the stat. To give the stat as a string, strip the +function name of the stat_ prefix. For example, to use stat_count(), +give the stat as "count".

        • +

      • For more information and other ways to specify the stat, see the +layer stat documentation.

        • +
      + + +
      position
      +

      A position adjustment to use on the data for this layer. +Cannot be jointy specified with nudge_x or nudge_y. This +can be used in various ways, including to prevent overplotting and +improving the display. The position argument accepts the following:

      • The result of calling a position function, such as position_jitter().

        • +

      • A string nameing the position adjustment. To give the position as a +string, strip the function name of the position_ prefix. For example, +to use position_jitter(), give the position as "jitter".

        • +

      • For more information and other ways to specify the position, see the +layer position documentation.

        • +
      + + +
      ...
      +

      Other arguments passed on to layer()'s params argument. These +arguments broadly fall into one of 4 categories below. Notably, further +arguments to the position argument, or aesthetics that are required +can not be passed through .... Unknown arguments that are not part +of the 4 categories below are ignored.

      • Static aesthetics that are not mapped to a scale, but are at a fixed +value and apply to the layer as a whole. For example, colour = "red" +or linewidth = 3. The geom's documentation has an Aesthetics +section that lists the available options. The 'required' aesthetics +cannot be passed on to the params. Please note that while passing +unmapped aesthetics as vectors is technically possible, the order and +required length is not guaranteed to be parallel to the input data.

        • +

      • When constructing a layer using +a stat_*() function, the ... argument can be used to pass on +parameters to the geom part of the layer. An example of this is +stat_density(geom = "area", outline.type = "both"). The geom's +documentation lists which parameters it can accept.

        • +

      • Inversely, when constructing a layer using a +geom_*() function, the ... argument can be used to pass on parameters +to the stat part of the layer. An example of this is +geom_area(stat = "density", adjust = 0.5). The stat's documentation +lists which parameters it can accept.

        • +

      • The key_glyph argument of layer() may also be passed on through +.... This can be one of the functions described as +key glyphs, to change the display of the layer in the legend.

        • +
      + + +
      min.size

      minimum number of points for a contour to be labelled.

      -
      skip
      +
      skip

      number of contours to skip

      -
      label.placer
      +
      label.placer

      a label placer function. See label_placer_flattest().

      -
      parse
      +
      parse

      If TRUE, the labels will be parsed into expressions and displayed as described in ?plotmath.

      -
      nudge_x, nudge_y
      +
      nudge_x, nudge_y

      Horizontal and vertical adjustment to nudge labels by. Useful for offsetting text from points, particularly on discrete scales. Cannot be jointly specified with position.

      -
      label.padding
      +
      label.padding

      Amount of padding around label. Defaults to 0.25 lines.

      -
      label.r
      +
      label.r

      Radius of rounded corners. Defaults to 0.15 lines.

      -
      label.size
      +
      label.size

      Size of label border, in mm.

      -
      na.rm
      +
      na.rm

      If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

      -
      show.legend
      +
      show.legend

      logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. @@ -198,23 +234,23 @@

      Arguments

      display.

      -
      inherit.aes
      +
      inherit.aes

      If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().

      -
      rotate
      +
      rotate

      logical indicating whether to rotate text following the contour.

      -
      stroke
      +
      stroke

      numerical indicating width of stroke relative to the size of the text. Ignored if less than zero.

      -
      check_overlap
      +
      check_overlap

      If TRUE, text that overlaps previous text in the same layer will not be plotted. check_overlap happens at draw time and in the order of the data. Therefore data should be arranged by the label @@ -231,7 +267,7 @@

      Details

      Aesthetics

      - +

      geom_text_contour understands the following aesthetics (required aesthetics are in bold):

      • x

        • @@ -251,7 +287,7 @@

        Aesthetics

      See also

      -

      Other ggplot2 helpers: +

      Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -270,8 +306,7 @@

      See also

      Examples

      - 
      data.table::setDTthreads(1)
-library(ggplot2)
+    
      library(ggplot2)
 v <- reshape2::melt(volcano)
 g <- ggplot(v, aes(Var1, Var2)) +
        geom_contour(aes(z = value))
@@ -321,15 +356,15 @@ 
      Examples
      
 
      
 
 
      
-  
      Site built with pkgdown 2.0.9.
      
+  
      Site built with pkgdown 2.1.0.
      - - + + diff --git a/reference/geom_vector.html b/reference/geom_vector.html new file mode 100644 index 00000000..2f903cdc --- /dev/null +++ b/reference/geom_vector.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/geopotential.html b/reference/geopotential.html index 74b927f3..4d9803c6 100644 --- a/reference/geopotential.html +++ b/reference/geopotential.html @@ -4,7 +4,7 @@ - +
      - +

      Geopotential height

      - Source: R/geopotential.R + Source: R/geopotential.R
      @@ -107,15 +107,15 @@

      Source

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/guide_colorstrip.html b/reference/guide_colorstrip.html new file mode 100644 index 00000000..1a65a319 --- /dev/null +++ b/reference/guide_colorstrip.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/guide_colourstrip.html b/reference/guide_colourstrip.html index ad5c7495..eb53c092 100644 --- a/reference/guide_colourstrip.html +++ b/reference/guide_colourstrip.html @@ -4,7 +4,7 @@ - +
      - +

      Discretized continuous colour guide

      - Source: R/guide_colorstrip.R + Source: R/guide_colorstrip.R
      @@ -121,54 +121,56 @@

      Discretized continuous colour guide

      Arguments

      -
      title
      + + +
      title

      A character string or expression indicating a title of guide. If NULL, the title is not shown. By default (waiver()), the name of the scale object or the name specified in labs() is used for the title.

      -
      draw.ulim
      +
      draw.ulim

      A logical specifying if the upper limit tick marks should be visible.

      -
      draw.llim
      +
      draw.llim

      A logical specifying if the lower limit tick marks should be visible.

      -
      inside
      +
      inside

      logical indicating where to position labels (see examples).

      -
      direction
      +
      direction

      A character string indicating the direction of the guide. One of "horizontal" or "vertical."

      -
      reverse
      +
      reverse

      logical. If TRUE the colourbar is reversed. By default, the highest value is on the top and the lowest value is on the bottom

      -
      order
      +
      order

      positive integer less than 99 that specifies the order of this guide among multiple guides. This controls the order in which multiple guides are displayed, not the contents of the guide itself. If 0 (default), the order is determined by a secret algorithm.

      -
      available_aes
      +
      available_aes

      A vector of character strings listing the aesthetics for which a colourbar can be drawn.

      -
      ...
      +
      ...

      ignored.

      -
      theme
      +
      theme

      A theme object to style the guide individually or differently from the plot's theme settings. The theme argument in the guide overrides, and is combined with, the plot's theme.

      @@ -176,20 +178,18 @@

      Arguments

      Value

      - - -

      A guide object.

      +

      A guide object.

      Details

      The default behaviour works fell for geom_contour_fill in which the colours represent the value between contour surfaces.

      -

      `inside = TRUE`` works better for geom_tile where the colour represents +

      `inside = TRUE“ works better for geom_tile where the colour represents the value of the data and is very similar to ggplot2::guide_legend.

      See also

      -

      Other ggplot2 helpers: +

      Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -248,15 +248,15 @@

      Examples

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/guide_gengrob.colorstrip.html b/reference/guide_gengrob.colorstrip.html new file mode 100644 index 00000000..1a65a319 --- /dev/null +++ b/reference/guide_gengrob.colorstrip.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/guide_geom.colorstrip.html b/reference/guide_geom.colorstrip.html new file mode 100644 index 00000000..1a65a319 --- /dev/null +++ b/reference/guide_geom.colorstrip.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/guide_train.colorstrip.html b/reference/guide_train.colorstrip.html new file mode 100644 index 00000000..1a65a319 --- /dev/null +++ b/reference/guide_train.colorstrip.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/index.html b/reference/index.html index d65c6a97..1ea0961d 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,9 +1,9 @@ -Function reference • metRPackage index • metR - +
      - +
      @@ -64,7 +64,7 @@

      Package information

      -

      metR metR-package

      +

      metR-package metR

      metR: Tools for Easier Analysis of Meteorological Fields

      @@ -316,15 +316,15 @@

      Datasets

      pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/is.cross.html b/reference/is.cross.html index 5edd69a7..f37c2baa 100644 --- a/reference/is.cross.html +++ b/reference/is.cross.html @@ -3,7 +3,7 @@ - +
      - +

      Cross pattern

      - Source: R/cross.R + Source: R/cross.R
      @@ -73,19 +73,19 @@

      Cross pattern

      Arguments

      -
      x, y
      + + +
      x, y

      x and y points that define a regular grid.

      -
      skip
      +
      skip

      how many points to skip. Greater value reduces the final point density.

      Value

      - - -

      is.cross returns a logical vector indicating whether each point belongs to the +

      is.cross returns a logical vector indicating whether each point belongs to the reduced grid or not. cross returns a list of x and y components of the reduced density grid.

      @@ -124,15 +124,15 @@

      Examples

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/is.full_season.html b/reference/is.full_season.html new file mode 100644 index 00000000..8f528ffd --- /dev/null +++ b/reference/is.full_season.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placement_all.html b/reference/label_placement_all.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placement_all.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placement_flattest.html b/reference/label_placement_flattest.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placement_flattest.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placement_fraction.html b/reference/label_placement_fraction.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placement_fraction.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placement_minmax.html b/reference/label_placement_minmax.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placement_minmax.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placement_n.html b/reference/label_placement_n.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placement_n.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placement_random.html b/reference/label_placement_random.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placement_random.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placer_all.html b/reference/label_placer_all.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placer_all.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placer_flattest.html b/reference/label_placer_flattest.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placer_flattest.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placer_fraction.html b/reference/label_placer_fraction.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placer_fraction.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placer_minmax.html b/reference/label_placer_minmax.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placer_minmax.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placer_n.html b/reference/label_placer_n.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placer_n.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placer_random.html b/reference/label_placer_random.html new file mode 100644 index 00000000..157e1011 --- /dev/null +++ b/reference/label_placer_random.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/label_placers.html b/reference/label_placers.html index c715eba3..8766cea1 100644 --- a/reference/label_placers.html +++ b/reference/label_placers.html @@ -3,7 +3,7 @@ - +
      - +

      Functions to place contour labels

      - Source: R/label-placement.R + Source: R/label-placement.R
      @@ -119,31 +119,33 @@

      Functions to place contour labels

      Arguments

      -
      frac
      + + +
      frac

      A numeric vector with values between 0 and 1 representing where in the contour to put labels (i.e. frac = 0.5 puts labels at the midpoint).

      -
      rot_adjuster
      +
      rot_adjuster

      A function that standardizes the rotation angles of the labels. See e.g. isoband::angle_halfcircle_bottom.

      -
      n
      +
      n

      Number of labels to put.

      -
      seed
      +
      seed

      Seed to use for randomly choosing where to put labels.

      -
      ref_angle
      +
      ref_angle

      Angle (in degrees counter-clockwise from East) to try to approximate labels.

      -
      direction
      +
      direction

      Direction in which to compute the maximum and minimum.

      @@ -160,15 +162,15 @@

      Arguments

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/label_scales.html b/reference/label_scales.html index f696ea97..b1ed19dd 100644 --- a/reference/label_scales.html +++ b/reference/label_scales.html @@ -3,7 +3,7 @@ - +
      - +

      Scales for contour label aesthetics

      - Source: R/label-scales.R + Source: R/label-scales.R
      @@ -91,16 +91,18 @@

      Scales for contour label aesthetics

      Arguments

      -
      ...
      + + +
      ...

      Arguments passed on to continuous_scale

      minor_breaks

      One of:

      • NULL for no minor breaks

        • -

      • waiver() for the default breaks (one minor break between -each major break)

        • +

      • waiver() for the default breaks (none for discrete, one minor break +between each major break for continuous)

      • A numeric vector of positions

      • A function that given the limits returns a vector of minor breaks. Also accepts rlang lambda function notation. When the function has two arguments, it will be given the limits and major -breaks.

        • +break positions.

      oob
      @@ -116,63 +118,52 @@

      Arguments

      na.value

      Missing values will be replaced with this value.

      -
      expand
      -

      For position scales, a vector of range expansion constants used to add some -padding around the data to ensure that they are placed some distance -away from the axes. Use the convenience function expansion() -to generate the values for the expand argument. The defaults are to -expand the scale by 5% on each side for continuous variables, and by -0.6 units on each side for discrete variables.

      - -
      position
      -

      For position scales, The position of the axis. -left or right for y axes, top or bottom for x axes.

      -
      call

      The call used to construct the scale for reporting messages.

      super

      The super class to use for the constructed scale

      - +
      -
      aesthetics
      +
      aesthetics

      Character string or vector of character strings listing the name(s) of the aesthetic(s) that this scale works with. This can be useful, for example, to apply colour settings to the colour and fill aesthetics at the same time, via aesthetics = c("colour", "fill").

      -
      guide
      +
      guide

      Type of legend. Use "colourbar" for continuous colour bar, or "legend" for discrete colour legend.

      -
      range
      +
      range

      Output range of alpha values. Must lie between 0 and 1.

      -
      name
      +
      name

      The name of the scale. Used as the axis or legend title. If waiver(), the default, the name of the scale is taken from the first mapping used for that aesthetic. If NULL, the legend title will be omitted.

      -
      breaks
      +
      breaks

      One of:

      • NULL for no breaks

      • waiver() for the default breaks computed by the transformation object

      • A numeric vector of positions

      • A function that takes the limits as input and returns breaks as output (e.g., a function returned by scales::extended_breaks()). +Note that for position scales, limits are provided after scale expansion. Also accepts rlang lambda function notation.

      -
      labels
      +
      labels

      One of:

      • NULL for no labels

      • waiver() for the default labels computed by the transformation object

        • @@ -184,7 +175,7 @@

        Arguments

      -
      limits
      +
      limits

      One of:

      • NULL to use the default scale range

      • A numeric vector of length two providing limits of the scale. Use NA to refer to the existing minimum or maximum

        • @@ -197,7 +188,7 @@

        Arguments

      -
      transform
      +
      transform

      For continuous scales, the name of a transformation object or the object itself. Built-in transformations include "asn", "atanh", "boxcox", "date", "exp", "hms", "identity", "log", "log10", "log1p", "log2", @@ -224,15 +215,15 @@

      Arguments

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/logic.html b/reference/logic.html index 19d39943..15491dc7 100644 --- a/reference/logic.html +++ b/reference/logic.html @@ -3,7 +3,7 @@ - +
      - +

      Extended logical operators

      - Source: R/small_funs.R + Source: R/small_funs.R
      @@ -73,19 +73,19 @@

      Extended logical operators

      Arguments

      -
      x, target
      + + +
      x, target

      numeric vectors

      -
      tol
      +
      tol

      tolerance for similarity

      Value

      - - -

      A logical vector of the same length of x.

      +

      A logical vector of the same length of x.

      Details

      @@ -97,7 +97,7 @@

      Details

      See also

      -

      Other utilities: +

      Other utilities: Anomaly(), JumpBy(), Mag(), @@ -135,15 +135,15 @@

      Examples

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/map_labels.html b/reference/map_labels.html index 161b38e9..b3facbc6 100644 --- a/reference/map_labels.html +++ b/reference/map_labels.html @@ -4,7 +4,7 @@ - +
      - +

      Label longitude and latitude

      - Source: R/scale_longitude.R + Source: R/scale_longitude.R
      @@ -75,15 +75,17 @@

      Label longitude and latitude

      Arguments

      -
      lon
      + + +
      lon

      longitude in degrees

      -
      east, west, north, south, zero
      +
      east, west, north, south, zero

      text to append for each quadrant

      -
      lat
      +
      lat

      latitude in degrees

      @@ -93,7 +95,7 @@

      Details

      See also

      -

      Other ggplot2 helpers: +

      Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -170,15 +172,15 @@

      Examples

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/metR-package.html b/reference/metR-package.html new file mode 100644 index 00000000..f380ac91 --- /dev/null +++ b/reference/metR-package.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/metR.html b/reference/metR.html index ce28f52d..1bf9f2cf 100644 --- a/reference/metR.html +++ b/reference/metR.html @@ -4,7 +4,7 @@ - +
      - +

      metR: Tools for Easier Analysis of Meteorological Fields

      - Source: R/metR-package.R + Source: R/metR-package.R
      @@ -70,7 +70,7 @@

      metR: Tools for Easier Analysis of Meteorological Fields

      Overview

      - +

      Conceptually it's divided into visualization tools and data tools. The former are geoms, stats and scales that help with plotting using @@ -104,15 +104,15 @@

      Author

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/reverselog_trans.html b/reference/reverselog_trans.html index 798832d1..a13b42eb 100644 --- a/reference/reverselog_trans.html +++ b/reference/reverselog_trans.html @@ -4,7 +4,7 @@ - +
      - +

      Reverse log transform

      - Source: R/reverselog_trans.R + Source: R/reverselog_trans.R
      @@ -73,13 +73,15 @@

      Reverse log transform

      Arguments

      -
      base
      + + +
      base

      Base of the logarithm

      See also

      -

      Other ggplot2 helpers: +

      Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -124,15 +126,15 @@

      Examples

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/sa_height.html b/reference/sa_height.html new file mode 100644 index 00000000..62d5f41f --- /dev/null +++ b/reference/sa_height.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/sa_height_axis.html b/reference/sa_height_axis.html new file mode 100644 index 00000000..62d5f41f --- /dev/null +++ b/reference/sa_height_axis.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/sa_height_breaks.html b/reference/sa_height_breaks.html new file mode 100644 index 00000000..62d5f41f --- /dev/null +++ b/reference/sa_height_breaks.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/sa_height_trans.html b/reference/sa_height_trans.html new file mode 100644 index 00000000..62d5f41f --- /dev/null +++ b/reference/sa_height_trans.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/sa_pressure.html b/reference/sa_pressure.html new file mode 100644 index 00000000..62d5f41f --- /dev/null +++ b/reference/sa_pressure.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/sa_pressure_axis.html b/reference/sa_pressure_axis.html new file mode 100644 index 00000000..62d5f41f --- /dev/null +++ b/reference/sa_pressure_axis.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/sa_pressure_trans.html b/reference/sa_pressure_trans.html new file mode 100644 index 00000000..62d5f41f --- /dev/null +++ b/reference/sa_pressure_trans.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/sa_temperature.html b/reference/sa_temperature.html new file mode 100644 index 00000000..62d5f41f --- /dev/null +++ b/reference/sa_temperature.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_color_divergent.html b/reference/scale_color_divergent.html new file mode 100644 index 00000000..e082fc6c --- /dev/null +++ b/reference/scale_color_divergent.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_colour_divergent.html b/reference/scale_colour_divergent.html new file mode 100644 index 00000000..e082fc6c --- /dev/null +++ b/reference/scale_colour_divergent.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_divergent.html b/reference/scale_divergent.html index 510ca649..a45a7899 100644 --- a/reference/scale_divergent.html +++ b/reference/scale_divergent.html @@ -4,7 +4,7 @@ - +
      - +

      Divergent colour scales

      - Source: R/scale_divergent.R + Source: R/scale_divergent.R
      @@ -104,7 +104,9 @@

      Divergent colour scales

      Arguments

      -
      ...
      + + +
      ...

      Arguments passed on to continuous_scale

      scale_name

      [Deprecated] The name of the scale that should be used for error messages associated with this scale.

      @@ -121,18 +123,19 @@

      Arguments

    • A numeric vector of positions

    • A function that takes the limits as input and returns breaks as output (e.g., a function returned by scales::extended_breaks()). +Note that for position scales, limits are provided after scale expansion. Also accepts rlang lambda function notation.

    minor_breaks

    One of:

    • NULL for no minor breaks

      • -

    • waiver() for the default breaks (one minor break between -each major break)

      • +

    • waiver() for the default breaks (none for discrete, one minor break +between each major break for continuous)

    • A numeric vector of positions

    • A function that given the limits returns a vector of minor breaks. Also accepts rlang lambda function notation. When the function has two arguments, it will be given the limits and major -breaks.

      • +break positions.

    n.breaks
    @@ -186,58 +189,46 @@

    Arguments

    [Deprecated] Deprecated in favour of transform.

    -
    expand
    -

    For position scales, a vector of range expansion constants used to add some -padding around the data to ensure that they are placed some distance -away from the axes. Use the convenience function expansion() -to generate the values for the expand argument. The defaults are to -expand the scale by 5% on each side for continuous variables, and by -0.6 units on each side for discrete variables.

    - -
    position
    -

    For position scales, The position of the axis. -left or right for y axes, top or bottom for x axes.

    -
    call

    The call used to construct the scale for reporting messages.

    super

    The super class to use for the constructed scale

    - + -
    low, high
    +
    low, high

    Colours for low and high ends of the gradient.

    -
    mid
    +
    mid

    colour for mid point

    -
    midpoint
    +
    midpoint

    The midpoint (in data value) of the diverging scale. Defaults to 0.

    -
    space
    +
    space

    colour space in which to calculate gradient. Must be "Lab" - other values are deprecated.

    -
    na.value
    +
    na.value

    Colour to use for missing values

    -
    guide
    +
    guide

    Type of legend. Use "colourbar" for continuous colour bar, or "legend" for discrete colour legend.

    See also

    -

    Other ggplot2 helpers: +

    Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -276,15 +267,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/scale_fill_discretised.html b/reference/scale_fill_discretised.html new file mode 100644 index 00000000..2ac13c89 --- /dev/null +++ b/reference/scale_fill_discretised.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_fill_divergent.html b/reference/scale_fill_divergent.html new file mode 100644 index 00000000..e082fc6c --- /dev/null +++ b/reference/scale_fill_divergent.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_fill_divergent_discretised.html b/reference/scale_fill_divergent_discretised.html new file mode 100644 index 00000000..2ac13c89 --- /dev/null +++ b/reference/scale_fill_divergent_discretised.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_label_alpha_continuous.html b/reference/scale_label_alpha_continuous.html new file mode 100644 index 00000000..8bed44e8 --- /dev/null +++ b/reference/scale_label_alpha_continuous.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_label_size_continuous.html b/reference/scale_label_size_continuous.html new file mode 100644 index 00000000..8bed44e8 --- /dev/null +++ b/reference/scale_label_size_continuous.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_latitude.html b/reference/scale_latitude.html new file mode 100644 index 00000000..f8f88a0c --- /dev/null +++ b/reference/scale_latitude.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_longitude.html b/reference/scale_longitude.html index 1cc5d31f..8dc9a6d0 100644 --- a/reference/scale_longitude.html +++ b/reference/scale_longitude.html @@ -6,7 +6,7 @@ - +
    - +

    Helpful scales for maps

    - Source: R/scale_longitude.R + Source: R/scale_longitude.R
    @@ -117,29 +117,32 @@

    Helpful scales for maps

    Arguments

    -
    name
    + + +
    name

    The name of the scale. Used as the axis or legend title. If waiver(), the default, the name of the scale is taken from the first mapping used for that aesthetic. If NULL, the legend title will be omitted.

    -
    ticks
    +
    ticks

    spacing between breaks

    -
    breaks
    +
    breaks

    One of:

    • NULL for no breaks

    • waiver() for the default breaks computed by the transformation object

    • A numeric vector of positions

    • A function that takes the limits as input and returns breaks as output (e.g., a function returned by scales::extended_breaks()). +Note that for position scales, limits are provided after scale expansion. Also accepts rlang lambda function notation.

    -
    expand
    +
    expand

    For position scales, a vector of range expansion constants used to add some padding around the data to ensure that they are placed some distance away from the axes. @@ -147,7 +150,7 @@

    Arguments

    the values for the expand argument.

    -
    labels
    +
    labels

    One of:

    • NULL for no labels

    • waiver() for the default labels computed by the transformation object

      • @@ -159,18 +162,18 @@

      Arguments

    -
    trans
    +
    trans

    [Deprecated] Deprecated in favour of transform.

    -
    ...
    +
    ...

    Other arguments passed on to scale_(x|y)_continuous()

    See also

    -

    Other ggplot2 helpers: +

    Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -217,15 +220,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/scale_mag.html b/reference/scale_mag.html index 2f08dd38..cbd3a871 100644 --- a/reference/scale_mag.html +++ b/reference/scale_mag.html @@ -4,7 +4,7 @@ - +
    - +

    Scale for vector magnitudes

    - Source: R/scale_vector.R + Source: R/scale_vector.R
    @@ -87,32 +87,35 @@

    Scale for vector magnitudes

    Arguments

    -
    name
    + + +
    name

    The name of the scale. Used as the axis or legend title. If waiver(), the default, the name of the scale is taken from the first mapping used for that aesthetic. If NULL, the legend title will be omitted.

    -
    n.breaks
    +
    n.breaks

    An integer guiding the number of major breaks. The algorithm may choose a slightly different number to ensure nice break labels. Will only have an effect if breaks = waiver(). Use NULL to use the default number of breaks given by the transformation.

    -
    breaks
    +
    breaks

    One of:

    • NULL for no breaks

    • waiver() for the default breaks computed by the transformation object

    • A numeric vector of positions

    • A function that takes the limits as input and returns breaks as output (e.g., a function returned by scales::extended_breaks()). +Note that for position scales, limits are provided after scale expansion. Also accepts rlang lambda function notation.

    -
    oob
    +
    oob

    One of:

    • Function that handles limits outside of the scale limits (out of bounds). Also accepts rlang lambda function notation.

      • @@ -123,7 +126,7 @@

      Arguments

    -
    ...
    +
    ...

    Other arguments passed on to scale_(x|y)_continuous()

    @@ -154,15 +157,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/scale_mag_continuous.html b/reference/scale_mag_continuous.html new file mode 100644 index 00000000..95925485 --- /dev/null +++ b/reference/scale_mag_continuous.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_stroke.colour_continuous.html b/reference/scale_stroke.colour_continuous.html index e9593092..3da3aa74 100644 --- a/reference/scale_stroke.colour_continuous.html +++ b/reference/scale_stroke.colour_continuous.html @@ -3,7 +3,7 @@ - +
    - +

    Scale for stroke.colour

    - Source: R/geom_text_contour.R + Source: R/geom_text_contour.R
    @@ -68,7 +68,9 @@

    Scale for stroke.colour

    Arguments

    -
    ...
    + + +
    ...

    parameters sent to ggplot2::scale_color_continuous

    @@ -85,15 +87,15 @@

    Arguments

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/scale_x_latitude.html b/reference/scale_x_latitude.html new file mode 100644 index 00000000..f8f88a0c --- /dev/null +++ b/reference/scale_x_latitude.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_x_level.html b/reference/scale_x_level.html new file mode 100644 index 00000000..f8f88a0c --- /dev/null +++ b/reference/scale_x_level.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_x_longitude.html b/reference/scale_x_longitude.html new file mode 100644 index 00000000..f8f88a0c --- /dev/null +++ b/reference/scale_x_longitude.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_y_latitude.html b/reference/scale_y_latitude.html new file mode 100644 index 00000000..f8f88a0c --- /dev/null +++ b/reference/scale_y_latitude.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_y_level.html b/reference/scale_y_level.html new file mode 100644 index 00000000..f8f88a0c --- /dev/null +++ b/reference/scale_y_level.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/scale_y_longitude.html b/reference/scale_y_longitude.html new file mode 100644 index 00000000..f8f88a0c --- /dev/null +++ b/reference/scale_y_longitude.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/season.html b/reference/season.html index 4d467a65..cca60552 100644 --- a/reference/season.html +++ b/reference/season.html @@ -3,7 +3,7 @@ - +
    - +

    Assign seasons to months

    - Source: R/season.R + Source: R/season.R
    @@ -75,19 +75,19 @@

    Assign seasons to months

    Arguments

    -
    x
    + + +
    x

    A vector of dates (alternative a numeric vector of months, for season())

    -
    lang
    +
    lang

    Language to use.

    Value

    - - -

    season() returns a factor vector of the same length as x with the trimester of each +

    season() returns a factor vector of the same length as x with the trimester of each month. seasonaly() returns a date vector of the same length as x with the date "rounded" up to the centre month of each season. @@ -124,15 +124,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/seasonally.html b/reference/seasonally.html new file mode 100644 index 00000000..8f528ffd --- /dev/null +++ b/reference/seasonally.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/smooth_dct.html b/reference/smooth_dct.html new file mode 100644 index 00000000..7afa8b36 --- /dev/null +++ b/reference/smooth_dct.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/smooth_svd.html b/reference/smooth_svd.html new file mode 100644 index 00000000..7afa8b36 --- /dev/null +++ b/reference/smooth_svd.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/spherical.html b/reference/spherical.html index 022cf285..178e23f7 100644 --- a/reference/spherical.html +++ b/reference/spherical.html @@ -4,7 +4,7 @@ - +
    - +

    Transform between spherical coordinates and physical coordinates

    - Source: R/small_funs.R + Source: R/small_funs.R
    @@ -79,19 +79,21 @@

    Transform between spherical coordinates and physical coordinates

    Arguments

    -
    dx, dy
    + + +
    dx, dy

    interval in meters

    -
    lat
    +
    lat

    latitude, in degrees

    -
    a
    +
    a

    radius of the Earth

    -
    dlon, dlat
    +
    dlon, dlat

    interval in degrees

    @@ -187,15 +189,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/standard_atmosphere.html b/reference/standard_atmosphere.html index 5d4304b8..d886bdb6 100644 --- a/reference/standard_atmosphere.html +++ b/reference/standard_atmosphere.html @@ -5,7 +5,7 @@ - +
    - +

    Standard atmosphere

    - Source: R/standard_atmosphere.R + Source: R/standard_atmosphere.R
    @@ -103,15 +103,17 @@

    Standard atmosphere

    Arguments

    -
    height
    + + +
    height

    height in meter

    -
    pressure
    +
    pressure

    pressure in pascals

    -
    height_in, pressure_in
    +
    height_in, pressure_in

    units of height and pressure, respectively. Possible values are "km", "m" for height and "hPa" and "Pa" for pressure. Alternatively, it can be a numeric constant that multiplied to convert the @@ -119,15 +121,15 @@

    Arguments

    use height_in = 0.3048.)

    -
    n
    +
    n

    desiderd number of breaks.

    -
    ...
    +
    ...

    extra arguments passed to scales::breaks_extended.

    -
    name, breaks, labels, guide
    +
    name, breaks, labels, guide

    arguments passed to ggplot2::sec_axis()

    @@ -216,15 +218,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/stat_contour2.html b/reference/stat_contour2.html new file mode 100644 index 00000000..a58f169e --- /dev/null +++ b/reference/stat_contour2.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/stat_contour_fill.html b/reference/stat_contour_fill.html new file mode 100644 index 00000000..31a882e1 --- /dev/null +++ b/reference/stat_contour_fill.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/stat_na.html b/reference/stat_na.html index 7d75587b..b835b032 100644 --- a/reference/stat_na.html +++ b/reference/stat_na.html @@ -4,7 +4,7 @@ - +
    - +

    Filter only NA values.

    - Source: R/stat_na.R + Source: R/stat_na.R
    @@ -81,14 +81,16 @@

    Filter only NA values.

    Arguments

    -
    mapping
    + + +
    mapping

    Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

    -
    data
    +
    data

    The data to be displayed in this layer. There are three options:

    If NULL, the default, the data is inherited from the plot @@ -102,27 +104,61 @@

    Arguments

    from a formula (e.g. ~ head(.x, 10)).

    -
    geom
    -

    The geometric object to use to display the data, either as a -ggproto Geom subclass or as a string naming the geom stripped of the -geom_ prefix (e.g. "point" rather than "geom_point")

    - - -
    position
    -

    Position adjustment, either as a string naming the adjustment -(e.g. "jitter" to use position_jitter), or the result of a call to a -position adjustment function. Use the latter if you need to change the -settings of the adjustment.

    - - -
    ...
    -

    Other arguments passed on to layer(). These are -often aesthetics, used to set an aesthetic to a fixed value, like -colour = "red" or size = 3. They may also be parameters -to the paired geom/stat.

    - - -
    show.legend
    +
    geom
    +

    The geometric object to use to display the data for this layer. +When using a stat_*() function to construct a layer, the geom argument +can be used to override the default coupling between stats and geoms. The +geom argument accepts the following:

    • A Geom ggproto subclass, for example GeomPoint.

      • +

    • A string naming the geom. To give the geom as a string, strip the +function name of the geom_ prefix. For example, to use geom_point(), +give the geom as "point".

      • +

    • For more information and other ways to specify the geom, see the +layer geom documentation.

      • +
    + + +
    position
    +

    A position adjustment to use on the data for this layer. This +can be used in various ways, including to prevent overplotting and +improving the display. The position argument accepts the following:

    • The result of calling a position function, such as position_jitter(). +This method allows for passing extra arguments to the position.

      • +

    • A string naming the position adjustment. To give the position as a +string, strip the function name of the position_ prefix. For example, +to use position_jitter(), give the position as "jitter".

      • +

    • For more information and other ways to specify the position, see the +layer position documentation.

      • +
    + + +
    ...
    +

    Other arguments passed on to layer()'s params argument. These +arguments broadly fall into one of 4 categories below. Notably, further +arguments to the position argument, or aesthetics that are required +can not be passed through .... Unknown arguments that are not part +of the 4 categories below are ignored.

    • Static aesthetics that are not mapped to a scale, but are at a fixed +value and apply to the layer as a whole. For example, colour = "red" +or linewidth = 3. The geom's documentation has an Aesthetics +section that lists the available options. The 'required' aesthetics +cannot be passed on to the params. Please note that while passing +unmapped aesthetics as vectors is technically possible, the order and +required length is not guaranteed to be parallel to the input data.

      • +

    • When constructing a layer using +a stat_*() function, the ... argument can be used to pass on +parameters to the geom part of the layer. An example of this is +stat_density(geom = "area", outline.type = "both"). The geom's +documentation lists which parameters it can accept.

      • +

    • Inversely, when constructing a layer using a +geom_*() function, the ... argument can be used to pass on parameters +to the stat part of the layer. An example of this is +geom_area(stat = "density", adjust = 0.5). The stat's documentation +lists which parameters it can accept.

      • +

    • The key_glyph argument of layer() may also be passed on through +.... This can be one of the functions described as +key glyphs, to change the display of the layer in the legend.

      • +
    + + +
    show.legend

    logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. @@ -130,7 +166,7 @@

    Arguments

    display.

    -
    inherit.aes
    +
    inherit.aes

    If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from @@ -139,7 +175,7 @@

    Arguments

    Aesthetics

    - +

    stat_na understands the following aesthetics (required aesthetics are in bold)

    • x

      • @@ -151,7 +187,7 @@

      Aesthetics

      See also

      stat_subset for a more general way of filtering data.

      -

      Other ggplot2 helpers: +

      Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -196,15 +232,15 @@

      Examples

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/stat_streamline.html b/reference/stat_streamline.html new file mode 100644 index 00000000..be69a05a --- /dev/null +++ b/reference/stat_streamline.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/stat_subset.html b/reference/stat_subset.html index 0563ebc5..150f8072 100644 --- a/reference/stat_subset.html +++ b/reference/stat_subset.html @@ -5,7 +5,7 @@ - +
    - +

    Subset values

    - Source: R/stat_subset.R + Source: R/stat_subset.R
    @@ -83,14 +83,16 @@

    Subset values

    Arguments

    -
    mapping
    + + +
    mapping

    Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

    -
    data
    +
    data

    The data to be displayed in this layer. There are three options:

    If NULL, the default, the data is inherited from the plot @@ -104,27 +106,61 @@

    Arguments

    from a formula (e.g. ~ head(.x, 10)).

    -
    geom
    -

    The geometric object to use to display the data, either as a -ggproto Geom subclass or as a string naming the geom stripped of the -geom_ prefix (e.g. "point" rather than "geom_point")

    - - -
    position
    -

    Position adjustment, either as a string naming the adjustment -(e.g. "jitter" to use position_jitter), or the result of a call to a -position adjustment function. Use the latter if you need to change the -settings of the adjustment.

    - - -
    ...
    -

    Other arguments passed on to layer(). These are -often aesthetics, used to set an aesthetic to a fixed value, like -colour = "red" or size = 3. They may also be parameters -to the paired geom/stat.

    - - -
    show.legend
    +
    geom
    +

    The geometric object to use to display the data for this layer. +When using a stat_*() function to construct a layer, the geom argument +can be used to override the default coupling between stats and geoms. The +geom argument accepts the following:

    • A Geom ggproto subclass, for example GeomPoint.

      • +

    • A string naming the geom. To give the geom as a string, strip the +function name of the geom_ prefix. For example, to use geom_point(), +give the geom as "point".

      • +

    • For more information and other ways to specify the geom, see the +layer geom documentation.

      • +
    + + +
    position
    +

    A position adjustment to use on the data for this layer. This +can be used in various ways, including to prevent overplotting and +improving the display. The position argument accepts the following:

    • The result of calling a position function, such as position_jitter(). +This method allows for passing extra arguments to the position.

      • +

    • A string naming the position adjustment. To give the position as a +string, strip the function name of the position_ prefix. For example, +to use position_jitter(), give the position as "jitter".

      • +

    • For more information and other ways to specify the position, see the +layer position documentation.

      • +
    + + +
    ...
    +

    Other arguments passed on to layer()'s params argument. These +arguments broadly fall into one of 4 categories below. Notably, further +arguments to the position argument, or aesthetics that are required +can not be passed through .... Unknown arguments that are not part +of the 4 categories below are ignored.

    • Static aesthetics that are not mapped to a scale, but are at a fixed +value and apply to the layer as a whole. For example, colour = "red" +or linewidth = 3. The geom's documentation has an Aesthetics +section that lists the available options. The 'required' aesthetics +cannot be passed on to the params. Please note that while passing +unmapped aesthetics as vectors is technically possible, the order and +required length is not guaranteed to be parallel to the input data.

      • +

    • When constructing a layer using +a stat_*() function, the ... argument can be used to pass on +parameters to the geom part of the layer. An example of this is +stat_density(geom = "area", outline.type = "both"). The geom's +documentation lists which parameters it can accept.

      • +

    • Inversely, when constructing a layer using a +geom_*() function, the ... argument can be used to pass on parameters +to the stat part of the layer. An example of this is +geom_area(stat = "density", adjust = 0.5). The stat's documentation +lists which parameters it can accept.

      • +

    • The key_glyph argument of layer() may also be passed on through +.... This can be one of the functions described as +key glyphs, to change the display of the layer in the legend.

      • +
    + + +
    show.legend

    logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. @@ -132,7 +168,7 @@

    Arguments

    display.

    -
    inherit.aes
    +
    inherit.aes

    If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from @@ -141,7 +177,7 @@

    Arguments

    Aesthetics

    - +

    stat_subset understands the following aesthetics (required aesthetics are in bold)

    • x

      • @@ -153,7 +189,7 @@

      Aesthetics

      See also

      stat_na for a more specialized stat for filtering NA values.

      -

      Other ggplot2 helpers: +

      Other ggplot2 helpers: MakeBreaks(), WrapCircular(), geom_arrow(), @@ -194,15 +230,15 @@

      Examples

      -

      Site built with pkgdown 2.0.9.

      +

      Site built with pkgdown 2.1.0.

      - - + + diff --git a/reference/surface.html b/reference/surface.html index 2608603d..6f928323 100644 --- a/reference/surface.html +++ b/reference/surface.html @@ -3,7 +3,7 @@ - +
    - +

    Surface height

    - Source: R/surface.R + Source: R/surface.R
    @@ -101,15 +101,15 @@

    Format

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/temperature.html b/reference/temperature.html index d3cbebc4..72fbe670 100644 --- a/reference/temperature.html +++ b/reference/temperature.html @@ -3,7 +3,7 @@ - +
    - +

    Air temperature

    - Source: R/temperature.R + Source: R/temperature.R
    @@ -102,15 +102,15 @@

    Source

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/thermodynamics.html b/reference/thermodynamics.html index 9776782d..e5d507fe 100644 --- a/reference/thermodynamics.html +++ b/reference/thermodynamics.html @@ -3,7 +3,7 @@ - +
    - +

    Thermodynamics

    - Source: R/IdealGas.R + Source: R/IdealGas.R
    @@ -81,67 +81,67 @@

    Thermodynamics

    Arguments

    -
    p
    + + +
    p

    pressure

    -
    t
    +
    t

    temperature

    -
    rho
    +
    rho

    density

    -
    R
    +
    R

    gas constant for air

    -
    theta
    +
    theta

    potential temperature

    -
    p0
    +
    p0

    reference pressure

    -
    kappa
    +
    kappa

    ratio of dry air constant and specific heat capacity at constant pressure

    -
    e
    +
    e

    vapour partial pressure

    -
    tv
    +
    tv

    virtual temperature

    -
    epsilon
    +
    epsilon

    ratio of dry air constant and vapour constant

    -
    w
    +
    w

    mixing ratio

    -
    es
    +
    es

    saturation vapour partial pressure

    -
    ws
    +
    ws

    saturation mixing ratio

    -
    td
    +
    td

    dewpoint

    Value

    - - -

    Each function returns the value of the missing state variable.

    +

    Each function returns the value of the missing state variable.

    Details

    @@ -174,7 +174,7 @@

    References

    See also

    -

    Other meteorology functions: +

    Other meteorology functions: Derivate(), EOF(), GeostrophicWind(), @@ -221,15 +221,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/waves.html b/reference/waves.html index 32572d3b..c99473e8 100644 --- a/reference/waves.html +++ b/reference/waves.html @@ -4,7 +4,7 @@ - +
    - +

    Fourier transform functions

    - Source: R/FitWave.R + Source: R/FitWave.R
    @@ -86,43 +86,43 @@

    Fourier transform functions

    Arguments

    -
    y
    + + +
    y

    numeric vector to transform

    -
    k
    +
    k

    numeric vector of wave numbers

    -
    x
    +
    x

    numeric vector of locations (in radians)

    -
    amplitude
    +
    amplitude

    numeric vector of amplitudes

    -
    phase
    +
    phase

    numeric vector of phases

    -
    wave
    +
    wave

    optional list output from FitWave

    -
    sum
    +
    sum

    whether to perform the sum or not (see Details)

    -
    action
    +
    action

    integer to disambiguate action for k = 0 (see Details)

    Value

    - - -

    FitWaves returns a a named list with components

    k
    +

    FitWaves returns a a named list with components

    k

    wavenumbers

    amplitude
    @@ -146,10 +146,8 @@

    Value

    the reconstructed signal of each wavenumber

    -

    FilterWave and WaveEnvelope return a vector of the same length as y

    - - -

    `

    +

    FilterWave and WaveEnvelope return a vector of the same length as y +`

    Details

    @@ -178,7 +176,7 @@

    References

    See also

    -

    Other meteorology functions: +

    Other meteorology functions: Derivate(), EOF(), GeostrophicWind(), @@ -188,8 +186,7 @@

    See also

    Examples

    - 
    data.table::setDTthreads(1)
-
+    
    
 # Build a wave with specific wavenumber profile
 waves <- list(k = 1:10,
               amplitude = rnorm(10)^2,
@@ -385,15 +382,15 @@ 
    Examples
    
 
    
 
 
    
-  
    Site built with pkgdown 2.0.9.
    
+  
    Site built with pkgdown 2.1.0.
    - - + + diff --git a/sitemap.xml b/sitemap.xml index 7a63e4f9..b0f90201 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,195 +1,67 @@ - - - - https://eliocamp.github.io/metR/404.html - - - https://eliocamp.github.io/metR/articles/Visualization-tools.html - - - https://eliocamp.github.io/metR/articles/Working-with-data.html - - - https://eliocamp.github.io/metR/articles/index.html - - - https://eliocamp.github.io/metR/authors.html - - - https://eliocamp.github.io/metR/index.html - - - https://eliocamp.github.io/metR/news/index.html - - - https://eliocamp.github.io/metR/reference/Anomaly.html - - - https://eliocamp.github.io/metR/reference/ConvertLongitude.html - - - https://eliocamp.github.io/metR/reference/Derivate.html - - - https://eliocamp.github.io/metR/reference/EOF.html - - - https://eliocamp.github.io/metR/reference/EPflux.html - - - https://eliocamp.github.io/metR/reference/FitLm.html - - - https://eliocamp.github.io/metR/reference/GeostrophicWind.html - - - https://eliocamp.github.io/metR/reference/GetSMNData.html - - - https://eliocamp.github.io/metR/reference/GetTopography.html - - - https://eliocamp.github.io/metR/reference/Impute2D.html - - - https://eliocamp.github.io/metR/reference/ImputeEOF.html - - - https://eliocamp.github.io/metR/reference/Interpolate.html - - - https://eliocamp.github.io/metR/reference/JumpBy.html - - - https://eliocamp.github.io/metR/reference/Mag.html - - - https://eliocamp.github.io/metR/reference/MakeBreaks.html - - - https://eliocamp.github.io/metR/reference/MaskLand.html - - - https://eliocamp.github.io/metR/reference/Percentile.html - - - https://eliocamp.github.io/metR/reference/ReadNetCDF.html - - - https://eliocamp.github.io/metR/reference/Smooth2D.html - - - https://eliocamp.github.io/metR/reference/Trajectory.html - - - https://eliocamp.github.io/metR/reference/WaveFlux.html - - - https://eliocamp.github.io/metR/reference/WrapCircular.html - - - https://eliocamp.github.io/metR/reference/as.path.html - - - https://eliocamp.github.io/metR/reference/coriolis.html - - - https://eliocamp.github.io/metR/reference/cut.eof.html - - - https://eliocamp.github.io/metR/reference/denormalise.html - - - https://eliocamp.github.io/metR/reference/discretised_scale.html - - - https://eliocamp.github.io/metR/reference/geom_arrow.html - - - https://eliocamp.github.io/metR/reference/geom_contour2.html - - - https://eliocamp.github.io/metR/reference/geom_contour_fill.html - - - https://eliocamp.github.io/metR/reference/geom_contour_tanaka.html - - - https://eliocamp.github.io/metR/reference/geom_relief.html - - - https://eliocamp.github.io/metR/reference/geom_streamline.html - - - https://eliocamp.github.io/metR/reference/geom_text_contour.html - - - https://eliocamp.github.io/metR/reference/geopotential.html - - - https://eliocamp.github.io/metR/reference/guide_colourstrip.html - - - https://eliocamp.github.io/metR/reference/index.html - - - https://eliocamp.github.io/metR/reference/is.cross.html - - - https://eliocamp.github.io/metR/reference/label_placers.html - - - https://eliocamp.github.io/metR/reference/label_scales.html - - - https://eliocamp.github.io/metR/reference/logic.html - - - https://eliocamp.github.io/metR/reference/map_labels.html - - - https://eliocamp.github.io/metR/reference/metR.html - - - https://eliocamp.github.io/metR/reference/reverselog_trans.html - - - https://eliocamp.github.io/metR/reference/scale_divergent.html - - - https://eliocamp.github.io/metR/reference/scale_longitude.html - - - https://eliocamp.github.io/metR/reference/scale_mag.html - - - https://eliocamp.github.io/metR/reference/scale_stroke.colour_continuous.html - - - https://eliocamp.github.io/metR/reference/season.html - - - https://eliocamp.github.io/metR/reference/spherical.html - - - https://eliocamp.github.io/metR/reference/standard_atmosphere.html - - - https://eliocamp.github.io/metR/reference/stat_na.html - - - https://eliocamp.github.io/metR/reference/stat_subset.html - - - https://eliocamp.github.io/metR/reference/surface.html - - - https://eliocamp.github.io/metR/reference/temperature.html - - - https://eliocamp.github.io/metR/reference/thermodynamics.html - - - https://eliocamp.github.io/metR/reference/waves.html - + +https://eliocamp.github.io/metR/404.html +https://eliocamp.github.io/metR/articles/Visualization-tools.html +https://eliocamp.github.io/metR/articles/Working-with-data.html +https://eliocamp.github.io/metR/articles/index.html +https://eliocamp.github.io/metR/authors.html +https://eliocamp.github.io/metR/index.html +https://eliocamp.github.io/metR/news/index.html +https://eliocamp.github.io/metR/reference/Anomaly.html +https://eliocamp.github.io/metR/reference/ConvertLongitude.html +https://eliocamp.github.io/metR/reference/Derivate.html +https://eliocamp.github.io/metR/reference/EOF.html +https://eliocamp.github.io/metR/reference/EPflux.html +https://eliocamp.github.io/metR/reference/FitLm.html +https://eliocamp.github.io/metR/reference/GeostrophicWind.html +https://eliocamp.github.io/metR/reference/GetSMNData.html +https://eliocamp.github.io/metR/reference/GetTopography.html +https://eliocamp.github.io/metR/reference/Impute2D.html +https://eliocamp.github.io/metR/reference/ImputeEOF.html +https://eliocamp.github.io/metR/reference/Interpolate.html +https://eliocamp.github.io/metR/reference/JumpBy.html +https://eliocamp.github.io/metR/reference/Mag.html +https://eliocamp.github.io/metR/reference/MakeBreaks.html +https://eliocamp.github.io/metR/reference/MaskLand.html +https://eliocamp.github.io/metR/reference/Percentile.html +https://eliocamp.github.io/metR/reference/ReadNetCDF.html +https://eliocamp.github.io/metR/reference/Smooth2D.html +https://eliocamp.github.io/metR/reference/Trajectory.html +https://eliocamp.github.io/metR/reference/WaveFlux.html +https://eliocamp.github.io/metR/reference/WrapCircular.html +https://eliocamp.github.io/metR/reference/as.path.html +https://eliocamp.github.io/metR/reference/coriolis.html +https://eliocamp.github.io/metR/reference/cut.eof.html +https://eliocamp.github.io/metR/reference/denormalise.html +https://eliocamp.github.io/metR/reference/discretised_scale.html +https://eliocamp.github.io/metR/reference/geom_arrow.html +https://eliocamp.github.io/metR/reference/geom_contour2.html +https://eliocamp.github.io/metR/reference/geom_contour_fill.html +https://eliocamp.github.io/metR/reference/geom_contour_tanaka.html +https://eliocamp.github.io/metR/reference/geom_relief.html +https://eliocamp.github.io/metR/reference/geom_streamline.html +https://eliocamp.github.io/metR/reference/geom_text_contour.html +https://eliocamp.github.io/metR/reference/geopotential.html +https://eliocamp.github.io/metR/reference/guide_colourstrip.html +https://eliocamp.github.io/metR/reference/index.html +https://eliocamp.github.io/metR/reference/is.cross.html +https://eliocamp.github.io/metR/reference/label_placers.html +https://eliocamp.github.io/metR/reference/label_scales.html +https://eliocamp.github.io/metR/reference/logic.html +https://eliocamp.github.io/metR/reference/map_labels.html +https://eliocamp.github.io/metR/reference/metR.html +https://eliocamp.github.io/metR/reference/reverselog_trans.html +https://eliocamp.github.io/metR/reference/scale_divergent.html +https://eliocamp.github.io/metR/reference/scale_longitude.html +https://eliocamp.github.io/metR/reference/scale_mag.html +https://eliocamp.github.io/metR/reference/scale_stroke.colour_continuous.html +https://eliocamp.github.io/metR/reference/season.html +https://eliocamp.github.io/metR/reference/spherical.html +https://eliocamp.github.io/metR/reference/standard_atmosphere.html +https://eliocamp.github.io/metR/reference/stat_na.html +https://eliocamp.github.io/metR/reference/stat_subset.html +https://eliocamp.github.io/metR/reference/surface.html +https://eliocamp.github.io/metR/reference/temperature.html +https://eliocamp.github.io/metR/reference/thermodynamics.html +https://eliocamp.github.io/metR/reference/waves.html +