riatelab/osrm

incorrect documentation: osrm does not require WGS84

JosiahParry opened this issue · 1 comments

JosiahParry commented

One of the undocumented features of osrm is that projected coordinate systems are first transformed to wgs84.
The documentation states that geometry must be lon lat. This is false.

osrm/R/osrmTable.R

Line 6 in c3720a2

#' and latitudes (WGS84). It can also be an sf object. If so, row names are used

There are a few possible ways to ameliorate this that I can see.

  1. emit a message or warning upon transformation
  2. add a details section to the osrm functions which document this practice
  3. do both :)

The latter would be my suggestion

rCarto commented

One of the undocumented features of osrm is that projected coordinate systems are first transformed to wgs84. The documentation states that geometry must be lon lat. This is false.

I understand that the documentation was not clear on the subject. WGS84 is only needed for non-geographic input formats.
When using spatial object the transformation to WGS84 is invisible to the user and the results are returned in the original CRS.
I'm not sure why we should warn the user about this transformation.

I've modified the doc to make it more clear.