Skip to content

Commit

Permalink
docs: website
Browse files Browse the repository at this point in the history
  • Loading branch information
rCarto committed Jan 22, 2025
1 parent 5006ce0 commit 3633b78
Show file tree
Hide file tree
Showing 176 changed files with 20,497 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ test.R
test.png
map.png

docs
# docs
/doc/
/Meta/

Expand Down
Empty file added docs/.nojekyll
Empty file.
6 changes: 6 additions & 0 deletions docs/CITATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Citation

<p>Giraud T (2025).
<em>mapsf: Thematic Cartography</em>.
<a href="https://doi.org/10.32614/CRAN.package.mapsf">doi:10.32614/CRAN.package.mapsf</a>, R package v1.0.0.
</p>
595 changes: 595 additions & 0 deletions docs/LICENSE.md

Large diffs are not rendered by default.

231 changes: 231 additions & 0 deletions docs/NEWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,231 @@
# mapsf 1.0.0

## Feat
- add alpha (transparency) for all types in mf_map() and in mf_raster()
- remove all deprecated functions and arguments: mf_legend_*() functions;
adjust in mf_arrow(); theme and export in mf_export(); theme in mf_init();
pt_pch, pt_cex, pt_pch_na, pt_cex_na in mf_legend(); unit from mf_scale();

## Docs
- update the cheat sheet
- update the main vignette


# mapsf 0.12.0

## Fix
- use 1/4 of line for typical offset space (title, credits, scale bar, north arrow etc.) ([#74](https://github.com/riatelab/mapsf//issues/74))
- change text adj to allow multiple lines titles in mf_title()
- make mf_inset_*() work on split windows ([#77](https://github.com/riatelab/mapsf//issues/77))
- add a message when values are outside class limits for type="choro"

## Feat
- add cex and adj args to mf_arrow(), better arrow shape, better real north adjustemnent
- add mf_get_pencil() function to create a pencil layer from a polygon layer
- add "Q6" and "ckmeans" classification methods to mf_get_breaks()
- add mf_get_borders() to extract borders from contiguous polygons



# mapsf 0.11.0

## Fix
- better management of label display in mf_graticule(), fix [#73](https://github.com/riatelab/mapsf//issues/73)

# mapsf 0.10.1

## Fix
- revert previous remove "export" and "theme" args from mf_export() to accommodate dependencies
- revert previous remove "theme" from mf_init() to accommodate dependencies


# mapsf 0.10.0

## Fix
- allow to plot non overlapping labels from a layer made of strictly overlapping features with mf_label() ([#65](https://github.com/riatelab/mapsf//issues/65))
- fully display mf_raster() legends after a terra::plot() call ([#67](https://github.com/riatelab/mapsf//issues/67))
- remove "export" and "theme" args from mf_export()
- remove "theme" from mf_init()

## Feat
- improved and cleaner documentation for mf_map() ([#62](https://github.com/riatelab/mapsf//issues/62))



# mapsf 0.9.0

## Fix
- add the possibility to use a scale bar in (US) maps using feet based CRS ([#59](https://github.com/riatelab/mapsf//issues/59))
- deprecate unit argument in mf_scale()
- remove wrong ellipsis propagation in mf_label()
- better environment management in mf_legend() to allow usage inside a
function ([#58](https://github.com/riatelab/mapsf//issues/58))
- fix raster legends (using type arg, see feat.) ([#60](https://github.com/riatelab/mapsf//issues/60))

## Feat
- add "interval", "continuous" and "classes" types with matching legends in
mf_raster() ([#60](https://github.com/riatelab/mapsf//issues/60))
- mf_raster() invisibly returns the initial raster



# mapsf 0.8.0

## Fix
- raise an error and display an informative message if no points are plotted
when type = "prop*"

## Feat
- add mf_distr(), a function to display a statistical distribution with
histogram, boxplot, stripchart and density curve
- add a lot of legend related args (leg_frame_border, leg_horiz, leg_adj,
leg_bg, leg_fg, leg_size, leg_border, leg_box_border, leg_box_cex)
- double legends (prop_choro, prop_typo, etc.) are stacked by default
- add legends for raster
- deprecate all mf_legend_*() functions
- add rev arg for function using pal to reverse named palettes
- add a q arg in mf_label() to select the quality of the non overlapping
placement

## Refactor
- use the maplegend pkg for legends (this change may introduce minor breaking
changes)
- use s2 instead of overcomplicated sf code for othographic proj in
mf_worldmap()
- use R base instead of C++ in mf_label() non overalapping placement


# mapsf 0.7.1

## Fix
- fix bug in color assignment in 'choro', 'prop_choro' and 'symb_choro' maps
when supplying "incomplete" breaks ([#56](https://github.com/riatelab/mapsf//issues/56))

# mapsf 0.7.0

## Fix
- use a vector of colors for lines if necessary in mf_label() ([#50](https://github.com/riatelab/mapsf//issues/50))
- enable pipe without side effects (no extra plot)
- use a default transparent background for insets
- deprecate "theme" arg in relevant function, adapt docs and vignettes, use
options() for themes instead of global variable & mimic the behaviour of
basetheme package
- force the use of cairo device, if available, in mf_export() for png
- fix wrong class allocation when using breaks = "jenks" ([#53](https://github.com/riatelab/mapsf//issues/53))
- exports using unprojected objects do not produce figures with inaccurate
height/width ratio anymore.

## Feat
- add expandBB arg in mf_map()
- add expandBB arg in mf_raster()
- add arg checking depending on type in mf_map()
- add an error message for functions that need a pre-existing plot
- add mf_graticule() to add graticule lines and labels
- set internally the 'add' arg for each map types in mf_map()



# mapsf 0.6.1


## Fix
- add explicit support for sfg objects in mf_base(), mf_map(..., type = "base")


# mapsf 0.6.0


## Fix
- use val_max in mf_prop() for LINES
- add message when mf_export() is based on longlat obj
- add a test for "x" class in mf_map()
- enable proportional symbol plots for single points when using "prop", "prop_typo" & "prop_choro" maps; see [#45](https://github.com/riatelab/mapsf//issues/45)
- fix a bug in color assignment when there is a mismatch between the number of classes and the size of the color palette
- add an error for method "geom" in mf_get_breaks() when min(x) <= 0
- remove Inf values from x when using mf_get_breaks()
- remove Inf values from x when using "prop", "prop_typo" & "prop_choro" maps
- add informative message when NA, 0 & Inf values are removed when using "prop", "prop_typo" & "prop_choro" maps
- add informative message when negative values are transformed to positive values when using "prop", "prop_typo" & "prop_choro" maps

## Feat
- add "prop_typo"" maps for LINES objects
- add mf_get_ratio() to get appropriate values for map width & height






# mapsf 0.5.0

## Fix
- remove "export" arg for exports based on terra rasters
- remove "bg"" arg in mf_map()
- add "pch = 20" default to plot points with mf_base()
- get sf back from Depends to Imports
- remove s2 related message for recent version of sf in mf_worldmap()

## Feat
- add "interactive" position for legends, north arrow, scale bar, annotation
- add self-adjusted rounded values for proportional circles legends

# mapsf 0.4.0

## Fix
- allow the display of raster with >=2 bands (not only exactly 3)
- avoid mf_map(..., type="symb") failing when there is only one modality
- make mf_export() aware of the export format with the filename extension only (+ deprecate "export"" arg)
- add a default maximum to maxcell arg for raster display in mf_raster()
- change smooth defaults in mf_raster(), TRUE if nlyr>=2, FALSE otherwise

## Feat
- add a web only vignette on faceted maps
- add a web only vignette on custom fonts
- add a cheat sheet
- add parameters to customize worldmaps (land and ocean colors and borders)
- add informatives messages concerning mf_map() input (checking type and variable names)


# mapsf 0.3.0

## Fix
* add support for native pipe
* suppress messages that appear when s2 use is switched with mf_worldmap()
* replace raster by terra in all things raster

## Feat
* add a web only vignette on insets
* add a web only vignette on themes
* add mf_background(), a function to plot a background image for map
* add support for raster in mf_export() and mf_init()


# mapsf 0.2.0

## Fix
* change default value for interpolate and display without extra margins in mf_raster()
* increase minimal R version to 3.6.0 to use hcl.colors()
* adjust the largest symbol size in mf_map(..., "prop*")
* remove frame around insets
* remove LazyData from DESCRIPTION
* use sf 'on the fly' projection for unprojected sf objects
* better display of titles and maps (tiny extra space around maps)
* add explicit default value for "add" arg in mapping functions
* allow to plot (coherent) GEOMETRYCOLLECTIONS
* better default for POINT and LINES in mf_map(..., type = "base")
* fix mf_worldmap() by bypassing s2 use


## Feat
* Added a `NEWS.md` file to track changes to the package.
* split mf_init() to mf_init() and mf_export()
* allow width AND height set in mf_export()
* allow raster as input in mf_init() and mf_export()
* allow to change existent theme settings directrly in mf_theme()
* make mf_theme() return the current theme
* add default value for txt, add bg arg (for background) in mf_credits()
* add coordinates positioning for maps with 2 legends
* add alpha arg for transparency in mapping functions using "pal"
* change the default theme value to a theme with only tiny margins
* a web only vignette on map export
* allow hcl.colors palette names use in mf_legend*() functions
Loading

0 comments on commit 3633b78

Please sign in to comment.