dhbin: Hexmaps of New Zealand Adminstrative Units

Description

The 20 District Health Boards are the main administrative and funding units of the NZ national health system. The Regions are the second-level government divisions . These functions draw stylised maps of the DHBs and regions, along the lines of "statebins" for the US states. The hexagon for each location can be coloured and sized to show numeric data, and it can also be split into six triangles to show proportion or composition data.

Usage

dhbin(radius = NULL, hex_colours = "lightskyblue", DHB_names=NULL, text_colour = "black",
 legend_opts = NULL, border = NULL, short = FALSE,cex=0.8)
dhtri(radius = NULL, tri_colours, DHB_names=NULL, text_colour = "black",
 legend_opts = NULL, short=FALSE,cex=0.8)
regionbin(radius = NULL, hex_colours = "lightskyblue", region_names=NULL,
 text_colour = "black", legend_opts = NULL, border = NULL, short = FALSE, tasman=TRUE,
 cex=0.7)
regiontri(radius = NULL, tri_colours, region_names=NULL, text_colour = "black",
 legend_opts = NULL,short=FALSE, tasman=TRUE, cex=0.7)

Arguments

radius

Vector of radius measurements for the coloured part of each hexagon, with 1 as a full hexagon. If any are greater than 1, the vector is scaled to have maximum value 0.95, which is also the default value for all hexagons. If it has names, they are matched to the DHB names or common alternative names.

hex_colours

Vector of colours as names or hashtag colours. If it has names, they are matched to the DHB names or common alternative names.

tri_colours

6-column matrix of colours for the six triangles in each hexagon. If it has row names, they are matched to the DHB names or common alternative names.

DHB_names,region_names

Vector of DHB names or region names. If NULL, the function will look for this as the names of radius then as the names of hex_colours or the rownames of tri_colours

text_colour

Colour for the label on all the hexagons.

legend_opts

a list with arguments to graphics::legend, not including x and y, which are supplied, and bty, which is forced to "n". If not NULL a legend is drawn.

border

NULL or a colour name to draw a border around each hex.

short

If TRUE, label each hexagon with a 1-3 character short abbreviation rather than the full name. Especially useful for faceting.

tasman

The Tasman District and Nelson City are considered as separate regions in most contexts, but as forming the Nelson Region in some contexts. Use tasman=FALSE when they are combined

cex

character expansion factor

Value

Called for its side-effect

References

Lumley T (2019) Stylised Choropleth Maps for New Zealand Regions and District Health Boards. arXiv:1912.04435

Examples

Run this code

# NOT RUN {
data(dhb_cars)
tris<-tri_alloc(dhb_cars[,-1], c("green","gold","orange","goldenrod"), names=dhb_cars$dhb )

dhtri(tri_colours=tris,
  legend=list(fill=c("green","gold","orange","goldenrod"),
         border=NA,
         legend=c("0","1","2","3+"),
         title="Cars/Household")
)


households<-rowSums(dhb_cars[,-1])
names(households)<-dhb_cars$dhb
dhbin(radius=sqrt(households))
title(main="Number of households in private dwellings")


opar<-par(mfrow=c(2,3),mar=c(1,1,1,1))
z<-rnorm(20)
for(i in 1:6){
  z<-(rnorm(20)+z)/sqrt(2)
  z1<- (z+4)/8
  col_z<-rgb(colorRamp(c("blue", "white","red"))(z1),max=255)
  dhbin(hex_colours=col_z,border="grey",short=TRUE,
        legend_opts=list(fill=c("red","white","blue"),
                         legend=c("High","Medium","Low"),
                         title=paste("Thing",i))
  ) 
}
par(opar)


data(region_ethnicity)
cols<-tri_alloc(as.matrix(region_ethnicity[,-1]),
	colours=hcl.colors(5,"Set2"),names=region_ethnicity$Area)

regiontri(tri_colours=cols,text_colour="white",
	legend_opts=list(fill=hcl.colors(5,"Set2"),
			 title="Ethnicity",
			 legend=names(region_ethnicity)[2:6]))
title(main="New Zealand regions")


# }