root676 / QNEAT3

QNEAT3 - Qgis Network Analysis Toolbox 3
GNU General Public License v3.0
64 stars 13 forks source link

Update language to match core QGIS algorithms #32

Open josephholler opened 4 years ago

josephholler commented 4 years ago

Hi there! I love this plugin for ease of use in teaching purposes. I'd like to make it even easier to use for teaching GIS with QGIS by changing some of the language for consistency with other core QGIS algorithms, namely Distance Matrix, Service area, and Shortest path. For example, in Distance Matrix the first set of points is called the Input point layer, identified by InputID, and the second set of points is called the Target point layer, identified by TargetID. In Shortest path and Service area, the network cost method is called Path type to calculate and the options are Shortest or Fastest. Those can be a little ambiguous, so I propose Shortest distance and Fastest time

root676 commented 4 years ago

Hi @josephholler! Thank you for your thoughts on the plugin wording - I definitely see why the renaming of the algorithms is beneficial for teaching purposes and I'm open to discuss changes in algorithm names.

A littel background on the design decisions made for QNEAT3: The plugin was originally designed to feature some more advanced analysis algorithms for mobility/traffic analysis (such as OD-Matrices and Iso-Area maps) which are currently not available in QGIS-core. This is also reflected by the algorithm names: In order to make it easier for people from the respective fields of research to find these specific algorithms, I chose names which are common in those fields of research (especially OD-Matrices and Iso-Areas --> Isochrones). Following this design decision I would like to keep the algorithm names as well as the parameter descriptions and field names as they are.

Besides those pure design decitions we are hitting another - even more important - barrierer: Changing output field names could result in breaking scripts/models for users who are using QNEAT3 algorithms with the model builder or in python scripts.

Regarding the changes in the description of the strategy parameter: This is a +1 for me! Good wording! What do you think?

josephholler commented 4 years ago

Thanks for looking at this! We probably should have divided all the suggestions into different pull requests: I hope you don't mind parsing the one request.

Algorithm names: agreed, keep these the same. We just have one suggestion: consistently use or do not use a dash with "OD Matrix". We prefer "OD Matrix".

Parameter descriptions: I understand motivation to call the two sets of points in an OD Matrix "origins" and "destinations". The original algorithm labels the first set of points "from point layer" in the input and "origin_id" in the output. Could they all be consistently labelled "origin point layer" and "origin id" if you want to stick with the "origin" language rather than QGIS "input layer" language? Similarly, change "to point layer" to "destination point layer". At least this design would not change the field names in the output but would still increase clarity and consistency within QNEAT3 and in relation to other research fields.

root676 commented 4 years ago

Hi, sorry for the delayed answer, my calender is a bit crammed these days ;)

@Algorithm Names: I'm fine with the 'dash-less' approach. @Parameter Descriptions: +1 for me - very good solution without changing the output field names. Can you push those changes in the PR?