This is a minor release adding a range of quality of life features, adding two new experimental functions, and fixing a few bugs.
trajMapStatic() and
trajLevelMapStatic() have been added as two new
experimental functions to provide {ggplot2}
equivalents of openair::trajPlot() and
openair::trajLevel().
{ggplot2}
incarnation of the trajectory plotting functions, but whether they will
sit in {openair}, {ggopenair} or
{openairmaps} and what they will be named is not
clear.The control and facet arguments of all
polar marker mapping functions (static and interactive) and trajectory
mapping functions are now passed to
openair::cutData().
The popup argument of all interactive polar marker
mapping functions can now take a vector of column names. If more than
one column is provided, it is automatically passed to
buildPopup() using its default values.
trajLevelMap() now has the control
argument, which maps directly onto the type argument of
openair::trajLevel(). Like other control
arguments elsewhere in {openairmaps}, this creates a “layer
control” menu.
networkMap() now uses different coloured markers for
different networks. If more than one network is specified, and
draw.legend is set to TRUE, a legend will also
be drawn for quick identification of different data sources.
Deprecations are now managed by the {lifecycle}
package. This currently only applies to the type
argument.
Fixed issues where multiple addPolarMarkers()
chained together would all show the same plot.
Fixed issue where ... and pollutant
weren’t being passed to addPolarMarkers().
Fixed issue in trajMap() caused by recent updates to
{dplyr} and {forcats}.
Fixed issue where polarMapStatic() and others would
turn factor facet levels into characters.
cutData(), will now be honoured by the
facet argument (thanks @Jair-89, #31).Fixed issue where polarMapStatic() and others would
error when trying to draw a legend.
This is a minor release containing several important new features
that expand the scope of the package. This also comes with several minor
breaking changes to improve consistency within
{openairmaps} and with {openair}.
BREAKING: The fig.width, fig.height,
iconHeight and iconWidth arguments have been
replaced with d.fig and d.icon. There are two
main justifications behind this:
This ensures consistency across all of
{openairmaps}, making it easier to switch between the
static and HTML map types.
Polar markers are almost always going to be circular (i.e., width
= height) so having one argument will streamline things. If users wish
to have non-circular markers, a vector of length two in the form
c(width, height) will provide the same
functionality.
BREAKING: The arguments in addPolarMarkers() have
been put in a more sensible order, leading with data,
pollutant and fun.
BREAKING: The date argument from
networkMap() has been replaced by
year.
Added “static” equivalents of all of the polar marker maps
written in {ggplot2}. While interactive HTML maps are
preferred, the static equivalents may be more appropriate for, e.g.,
academic publications.
The {ggplot2} functions can be identified by
“Static” being appended to the function name. For example,
polarMap() is the {leaflet} polar plot map,
whereas polarMapStatic() is the {ggplot2}
equivalent.
Currently, “static” versions of the trajectory maps are served by
openair::trajPlot() and openair::trajLevel(),
but there may be space in future to have ggmap equivalents
of these in openairmaps.
Added diffMap() and diffMapStatic()
which are to openair::polarDiff() what
polarMap() and polarMapStatic() are to
openair::polarPlot(). Also added
addPolarDiffMarkers(), which is the equivalent of
addPolarMarkers().
Added alpha as an argument to all of the directional
analysis polar mapping functions, not just
polarMap().
Fixed alpha to work on both Windows and MacOS by
forcing the use of the “cairo” device to save plots.
Polar marker maps and addPolarMarkers() now show a
progress bar when creating the markers takes more than a few seconds
(most commonly in polarMap() and annulusMap(),
particularly with multiple pollutants/control groups).
networkMap() can now pass the new year
option to importMeta().
This is a patch release primarily to fix a few bugs in
{openairmaps}, and implement a new default colour scheme
after a recent {openair} update.
Fixed issue with polar marker maps (e.g.,
polarMap()) and the generic addPolarMarkers()
function where lat/lon info in the Southern Hemisphere would misalign
markers. Hat tip to Deanna Tuxford and James/“@jenright-git” for noticing this
issue.
Fixed an issue with networkMap() where
control = "variable" would fail to show all
pollutants.
This is a minor release, mainly focusing on enhancing the ability for polar markers to have shared colour scales, but also incorporating new features for network visualisation.
All directional analysis maps can now have their limits provided
(can be “limits”, “breaks”, “percentiles”, etc., depending on function).
This was always possible through ..., but it is now
explicitly listed as an option.
If limits are defined in a directional analysis function, a
shared legend will now be drawn at the top-right of the map. This
functionality can be disabled by setting draw.legend to
FALSE.
Added the buildPopup() function, which allows users
to easily construct HTML popups for use with the “popup” argument of
directional analysis maps (or leaflet maps more
widely).
The default options for fig.width and fig.height are now
3.5 rather than 4. This appears to remove some
visual artefacts and makes the axis labels more legible.
networkMap() now supports multiple sources. For
example, using source = c("aurn", "saqn") will show both
the AURN and SAQN on one map. This may be useful if users are interested
in air quality in a specific region of the UK (e.g., users may wish to
locate AURN, AQE and locally managed sites near to a given
urban centre).
networkMap() now supports
source = "local".
Multiple basemap providers can now be used with
networkMap().
networkMap(), trajMap() and all polar
directional analysis maps have gained the collapse.control
argument, which controls whether the control menu starts collapsed or
not. It defaults to FALSE, which means the control menu is
not collapsed.
All documentation has been improved; function parameters are more
consistent between functions and arguments passed to
openair via ... are now explicitly
listed.
polarMap() as it only ever worked for
polarMap().This is a patch release designed to fix a major bug in v0.5.0.
This is a minor release centred around the addition of the
control argument, which allows for arbitrary columns to be
used in “layer control” menus.
All functions now use latitude and longitude to distinguish
between site types. Therefore, “type” is now deprecated. Maps using the
old system will still render, but popups will not be displayed. For most
users, to restore previous site labels simply rewrite
type = "site" as popup = "site".
The default values for “pollutant” have all been removed. Any
users relying on this default should update their code to explicitly
state pollutant = "nox".
All functions now possess the “control” argument, which allows
users to create a “layer control” menu with any arbitrary column.
Appropriate columns may be those produced using
openair::cutData(), openair::splitByDate(), or
a user-defined
dplyr::case_when()/dplyr::if_else() column
transformation.
All functions now possess the “popup” and “label” arguments, which control pop-up and hover-over labels, respectively. This allows users to define any popup or label column, even non-unique ones. For example, multiple sites can be labelled with identical site types.
All functions now try to guess the latitude/longitude column if
not provided, similar to {leaflet}.
Updated many error messages and warnings to use
{cli} and be broadly more descriptive.
trajMap() can now be coloured by date.
Fixed issue with trajMap() that would cause
user-defined colours not to work.
This is a patch release adding a small number of refinements.
polar_data column names changed from “latitude” to
“longitude” to “lat” and “lon” to reflect the defaults of the
polarMap() family.
trajMap() and trajLevelMap() now use
the argument names “latitude” and “longitude” to match those of the
polarMap() family.
trajLevelMap() now contains the lat.inc
and lon.inc arguments.This is a patch release to fix a bug with
trajLevelMap().
trajLevelMap() now works where
statistic = "frequency" without a “pollutant”.This is the first CRAN release of {openairmaps}.
There are currently three streams of functionality in
openairmaps:
networkMap() visualises any of the
openair::importMeta() networks.
polarMap() and family allow for any of the
openair directional analysis plots to be used as leaflet
markers.
trajMap() and family are leaflet equivalents to
openair::trajPlot() and
openair::trajMap().
There are two main classes of functions:
*Map() functions are easy-to-use functions which
create leaflet maps from the ground-up. These are the most similar to
openair functions.
add*() functions are more flexible and allow users
to add layers to existing leaflet maps. These are designed to be similar
to the leaflet “add” functions like
addMarkers().