osmnxr/_pkgdown.yml at main · StrategicProjects/osmnxr · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
url: https://strategicprojects.github.io/osmnxr/

template:
  bootstrap: 5
  bootswatch: cosmo
  bslib:
    primary: "#0d3b66"
    border-radius: 0.5rem
    btn-border-radius: 0.25rem

navbar:
  structure:
    left:  [intro, reference, articles]
    right: [search, github]
  components:
    articles:
      text: Articles
      menu:
        - text: Getting started
          href: articles/getting-started.html
        - text: "---"
        - text: Routing and isochrones
          href: articles/routing-and-isochrones.html
        - text: Accessibility analysis
          href: articles/accessibility.html
        - text: "---"
        - text: Urban metrics
          href: articles/urban-metrics.html
        - text: Street orientation
          href: articles/street-orientation.html
        - text: Figure-ground diagrams
          href: articles/figure-ground.html
        - text: Features and points of interest
          href: articles/features-and-pois.html
        - text: Interoperability and export
          href: articles/interoperability.html

home:
  title: "osmnxr: OpenStreetMap street networks for R"
  description: >
    A tidyverse-friendly toolkit, inspired by the OSMnx Python library, to
    download, model, simplify, analyze and visualize street networks from
    OpenStreetMap, powered by a bundled Rust core.

reference:
  - title: "Download networks"
    desc: "Build routable street graphs from OpenStreetMap."
    contents:
      - ox_graph_from_place
      - ox_graph_from_address
      - ox_graph_from_point
      - ox_graph_from_bbox

  - title: "Features"
    desc: "Download points of interest, buildings and amenities."
    contents:
      - ox_features_from_place
      - ox_features_from_bbox

  - title: "Geocoding"
    contents:
      - ox_geocode
      - ox_geocode_to_sf

  - title: "Network processing"
    desc: "Clean and transform graph topology (Rust core)."
    contents:
      - ox_simplify
      - ox_consolidate_intersections
      - ox_add_edge_speeds
      - ox_add_edge_travel_times

  - title: "Routing"
    desc: "Shortest paths, distances and service areas (Rust core)."
    contents:
      - ox_nearest_nodes
      - ox_nearest_edges
      - ox_shortest_path
      - ox_k_shortest_paths
      - ox_distances
      - ox_distance_matrix
      - ox_isochrone

  - title: "Metrics"
    desc: "Urban and network statistics (Rust core)."
    contents:
      - ox_basic_stats
      - ox_centrality
      - ox_circuity
      - ox_bearings
      - ox_orientation_entropy
      - ox_plot_orientation
      - ox_plot_figure_ground

  - title: "Interoperability"
    desc: "Hand graphs to the wider R network ecosystem."
    contents:
      - ox_as_sfnetwork
      - ox_as_tidygraph
      - ox_as_dodgr

  - title: "Export and persistence"
    contents:
      - ox_to_geojson
      - ox_to_maplibre
      - ox_save_graphml
      - ox_load_graphml

  - title: "The osm_graph object"
    contents:
      - new_osm_graph
      - is_osm_graph
      - ox_as_sf
      - plot.osm_graph
      - ox_example
      - example_osm_graph

  - title: "Configuration"
    contents:
      - ox_settings
      - ox_clear_cache

footer:
  structure:
    left: developed_by
    right: built_with