Provide unit for distance in get_nearest_station

52North / sensorweb4R

Access to sensor data using the 52°North Sensor Web Client API

Apache License 2.0

8 stars 8 forks source link

Closed nuest closed 9 years ago

nuest commented 9 years ago

Running the example in #1 I don't know if the distance is in meters or ... degrees?

We could to two things:

add a "[unit]" to the name of the distance variable (which I don't like because a user hast to type that in every time)
use ?attributes to set the unit of measurement: attributes(get_nearest_stations(...)[["distance"]]) would return a list including uom = m.

@autermann Your opinion?

autermann commented 9 years ago

According to ?geospheree::distVincentyEllipsoid:

Distance value in the same units as the ellipsoid (default is meters)

So get_nearest_stations will always return meters. Why not just add this as a note to the doc?

nuest commented 9 years ago

Good point - add a note, please :-).

autermann commented 9 years ago

#' The distance is calculated using computations on an ellipsoid and the
#' returned value is in meters.