Documentation for v4: suggested update to

[MatthieuStigler]

Is there an official documentation for v4, besides "tmap v4: a sneak peek" (link)?

It seems that the code on Multivarite Scales on that page needs to be updated to:

tm_shape(World) +
  tm_fill(fill = tm_mv("well_being", "footprint"), 
          fill.scale = tm_scale_bivariate(scale1 = tm_scale_intervals(breaks = c(2, 5, 6, 8)),
                                          scale2 = tm_scale_intervals(breaks = c(0, 3, 6, 20)),
                                          values = "brewer.qualseq"))

Thanks!

[Nowosad]

Hi @MatthieuStigler -- I think that https://r.geocompx.org/adv-map is the most current documentation for tmap v4. We also plan to update https://r-tmap.github.io/tmap-book/ some time in the future, when the version 4 is on CRAN.

[MatthieuStigler]

ok, thanks for the info!

It would be nice to mention the main reference in the message?

Breaking News: tmap 3.x is retiring. Please test v4, e.g. with

The problem is that a naive search will rather lead to "tmap v4: a sneak peek" (link), which is sometimes outdated?

Thanks a lot!!

[Nowosad]

@MatthieuStigler where I can find the "Breaking News: tmap 3.x is retiring. Please test v4, e.g. with" message? I was unable to find it...

[MatthieuStigler]

true, that message comes with tmap 3.3.4, and presumably was removed with tmap 3.99.9, my bad.

So I guess one could consider adding a new message to 3.99.9, mentioning it's a massive change (sic) and pointing to some documentation helping users understand new/different code?

Thanks!

[Nowosad]

👍🏻 I like this idea. What do you think @mtennekes?

[nickbearman]

@MatthieuStigler where I can find the "Breaking News: tmap 3.x is retiring. Please test v4, e.g. with" message? I was unable to find it...

Yes I think this is with tmap v3.3-4.

New users, installing via CRAN install.packages("tmap") still get this message:

I think this should be updated with a link to more info, as @MatthieuStigler suggests.

[mtennekes]

Indeed good idea to add a message to 3.99.9 @MatthieuStigler

I'm a bit reluctant to send a new 3.x version to CRAN just to make the startup message more informative.

The best we can (and should) do is to make the home page (https://github.com/r-tmap/tmap) up-to-date and to the point. Until our book has been updated, https://r.geocompx.org/adv-map should be mentioned as the main source of documentation.

Please feel free to PR. Atm, I'm working on probably the last big hurdle of tmap4, namely shiny integration.

[olivroy]

Note that the documentation for v4 lives on pkgdown site (dev version) https://r-tmap.github.io/tmap/dev/.

The reason for using v3.99.9001 is to make it easier to update to v4.0 when it is released to CRAN.

~Changed the tooltip to say this is v4 in-development in 5568c3d~ No effect (possibly a pkgdown issue)

Added a nudge to v4 to v3 site in 3443b24

[nickbearman]

I have also added these links to the main text, and corrected a few typos in https://github.com/r-tmap/tmap/pull/901