@@ -87,7 +87,7 @@ devtools::install_github("fncokg/insetplot")
8787
8888Full documentation and more examples are available at [ insetplot package site] ( https://fncokg.github.io/insetplot/ ) .
8989
90- ## Core functions
90+ ## Fast overview of main functions
9191
9292- ` inset_spec() ` — Define bbox, position, and size for each subplot
9393 - bbox: ` xmin, xmax, ymin, ymax `
@@ -97,15 +97,14 @@ Full documentation and more examples are available at [insetplot package site](h
9797 - ` main ` : exactly one spec must set ` main = TRUE `
9898
9999- ` config_insetmap() ` — Build and store configuration
100- - ` bbox ` : overall bounding box (sf bbox or similar)
101- - ` to_crs ` : target Coordinate Reference System
102- - ` from_crs ` : source CRS for non-sf inputs
103- - ` specs ` : list of ` inset_spec() `
104- - ` crs ` : target CRS (passed to coord_sf as ` crs ` )
105- - ` border_args ` : forwarded to ` map_border() ` for inset borders
100+ - ` specs ` : list of ` inset_spec() ` , ** required**
101+ - ` bbox ` : overall bounding box (sf bbox or similar), * optional* (all specs must have fullly defined bboxes if omitted)
102+ - ` to_crs ` : target Coordinate Reference System, * optional* , by default "EPSG:4326"
103+ - ` from_crs ` : source CRS for non-sf inputs, * optional* , by default "EPSG:4326"
104+ - ` border_args ` : forwarded to ` map_border() ` for inset borders, * optional*
106105
107106- ` with_inset() ` — Compose main plot with insets
108- - ` plot ` : single ggplot or list per spec (optional)
107+ - ` plot ` : single ggplot or list per spec
109108 - ` .as_is ` : return the input plot as-is (skip inset composition)
110109 - ` .return_details ` : return ` list(full, subplots, subplot_layouts, main_ratio) `
111110
0 commit comments