Skip to contents

Start an atlas with a title, explanatory text, units and source attribution. Add areas or nodes and relationships before exporting it.

Usage

atlas(title = "Offline atlas", description = "", notice = "",
      sources = character(), units = "",
      entity_name = "entity", entity_names = "entities")

Arguments

title

Plain text for the atlas title.

description

Plain text for the introductory explanation.

notice

Plain text for the interpretation notice.

sources

Character vector of source and attribution text. URLs remain plain text and do not load external resources.

units

Plain text for the numeric units.

entity_name

Singular entity term, such as family or country, used in search, selection instructions and figure captions.

entity_names

Plural entity term, such as families or countries.

Details

Metadata are plain text. Columns are mapped by quoted names in the layer functions. Areas, nodes and relationships can each be added once. Add nodes before relationships. Geographic areas can be combined with geographic nodes; schematic nodes cannot be combined with geographic areas.

R prepares the atlas. The exported HTML embeds its data, geometry, JavaScript, CSS and optional illustration. Viewing it requires no R installation, server, API key or internet connection. The API is experimental.

Value

An offline_atlas object, suitable for piping into another configuration function or export_html.

See also

add_areas, add_nodes, add_edges, export_html.

For the tutorial, see the offlineatlas package overview.

Examples

m <- atlas("My atlas", description = "A small research example",
           units = "USD", entity_name = "country", entity_names = "countries")
print(m)
#> My atlas 
#>  0 nodes, 0 relationships, 0 areas
#> Use export_html() to create a standalone file.