Description

Convert numeric arrays into formatted strings.

Usage

getFormatNums(
  v,
  thousands = "",
  decimals = getOption("OutDec"),
  values.rnd = 0,
  prefix = "",
  suffix = "",
  align = "left",
  leadzero = TRUE,
  replace.zero = NULL
)

Arguments

Details

If suffix contains "%" the values are converted to percentages.

NA values of v are converted to "NA" .

If replace.zero is not NULL , exact zeroes would be replaced for this value.

Value

A character vector containing the formatted values.

Author

dieghernan, https://github.com/dieghernan/

Examples

library(sf)
## Linking to GEOS 3.5.1, GDAL 2.2.2, PROJ 4.9.2
mtq <-
  st_read(system.file("gpkg/mtq.gpkg", package = "cartography"))
## Reading layer `mtq' from data source `/home/rstudio-user/R/x86_64-pc-linux-gnu-library/3.6/cartography/gpkg/mtq.gpkg' using driver `GPKG'
## Simple feature collection with 34 features and 7 fields
## geometry type:  MULTIPOLYGON
## dimension:      XY
## bbox:           xmin: 690574 ymin: 1592536 xmax: 735940.2 ymax: 1645660
## epsg (SRID):    32620
## proj4string:    +proj=utm +zone=20 +datum=WGS84 +units=m +no_defs
# Population density
mtq$POPDENS <- 1e6 * mtq$POP / st_area(x = mtq)
brks <- getBreaks(mtq$POPDENS, 6)
cols <- carto.pal("red.pal", 6)
labs <- getFormatNums(brks,
                      thousands = ",",
                      suffix = " in/km2",
                      align = "right")

choroLayer(mtq,
           var = "POPDENS",
           col = cols,
           legend.pos = "n")
legendChoro(
  breaks = labs,
  col = cols,
  title.txt = "Population Density",
  pos = "topright"
)

# Percentage of population
mtq$PORCPOP <- mtq$POP / sum(mtq$POP)

brks <- seq(-1, 1, .2)
brks <- c(brks,NA)
cols = carto.pal("sand.pal", 20)
labs <- getFormatNums(
  brks,
  values.rnd = 2,
  leadzero = FALSE,
  replace.zero = "zero"
)

choroLayer(mtq,
           var = "PORCPOP",
           col = cols,
           legend.pos = "n")

legendChoro(
  breaks = labs,
  col = cols,
  title.txt = "Population Distr.",
  pos = "topright",
  nodata = FALSE
)

# Area percent
mtq$AREA <- (st_area(mtq) / sum(st_area(mtq)))

brks <- getBreaks(mtq$AREA, method = "q6")
cols = carto.pal("orange.pal", 6)
labs <-
  getFormatNums(brks,
                suffix = "%",
                values.rnd = 1,
                prefix = "<")
choroLayer(mtq,
           var = "AREA",
           legend.pos = "n",
           col = cols)

legendChoro(
  breaks = labs,
  col = cols,
  title.txt = "% Area",
  pos = "left",
  nodata = FALSE
)