_pkgdown.yml

url: https://docs.ropensci.org/osmapiR/
template:
  bootstrap: 5
deploy:
  install_metadata: true
reference:
- title: ""
  desc: >
    All function starting with `osm_*` include calls to the server.
- title: "OSM objects"
- subtitle: "Get OSM objects"
  contents:
  - has_concept("get OSM objects' functions")
- subtitle: "Edit OSM objects"
  contents:
  - has_concept("edit OSM objects' functions")
- title: "Changesets"
  desc: >
    Every modification of the standard OSM elements has to reference an open changeset. A changeset may contain tags
    just like the other elements. A recommended tag for changesets is the key ''comment=*'' with a short human readable
    description of the changes being made in that changeset. A new changeset can be opened at any time and a changeset
    may be referenced from multiple API calls. Because of this it can be closed manually as the server can't know when
    one changeset ends and another should begin. To avoid stale open changesets a mechanism is implemented to
    automatically close changesets. See [OSM wiki](https://wiki.openstreetmap.org/wiki/Changeset) for details.
- subtitle: "Get changesets"
  contents:
  - has_concept("get changesets' functions")
- subtitle: "Edit changeset"
  contents:
  - has_concept("edit changeset's functions")
- subtitle: "Changeset's discussion"
  contents:
  - has_concept("changeset discussion's functions")
- title: "Map notes"
  desc: >
    This functions provides access to the [notes](https://wiki.openstreetmap.org/wiki/Notes) feature, which allows users
    to add geo-referenced textual \"post-it\" notes.
- subtitle: "Get map notes"
  contents:
  - has_concept("get notes' functions")
- subtitle: "Edit map notes"
  contents:
  - has_concept("edit notes' functions")
- title: "GPS' traces"
  desc: >
    In violation of the [GPX standard](https://www.topografix.com/GPX/1/1/#type_trksegType) when downloading public GPX
    traces through the API, all waypoints of non-trackable traces are randomized (or rather sorted by lat/lon) and
    delivered as one trackSegment for privacy reasons. Trackable traces are delivered, sorted by descending upload time,
    before the waypoints of non-trackable traces.
- subtitle: "Get GPS traces"
  contents:
  - has_concept("get GPS' functions")
- subtitle: "Edit GPS traces"
  contents:
  - has_concept("edit GPS traces' functions")
- title: "Users"
  contents:
  - has_concept("users' functions")
- title: "OsmChange"
  desc: >
    The [OsmChange](https://wiki.openstreetmap.org/wiki/OsmChange) format can be uploaded to the server. This is
    guaranteed to be running in a transaction. So either all the changes are applied or none. To avoid performance
    issues when uploading multiple objects, the use of the `osm_diff_upload_changeset()` is highly recommended.
  contents:
  - has_concept("OsmChange's functions")
- title: "Methods"
  contents:
  - has_concept("methods")
- title: "API"
  contents:
  - has_concept("API functions")
- title: "For moderators"
  contents:
  - has_concept("functions for moderators")