Merge PR#363 (documentation)

Textual changes to documentation

docs/invoer.rst

@@ -67,7 +67,7 @@ De NICHE bodemkaart speelt een rol:
 Brongegevens
 ------------
 Voor het aanmaken van deze ecologische NICHE bodemkaart kan er gebruik gemaakt worden van de Bodemkaart van België, van een gecorrigeerde bodemkaart (op basis van veldgegevens) of er kan gebruik gemaakt worden van een zelf aangemaakte bodemkaart. Er is een Vlaanderen dekkende NICHE bodemkaart voorhanden, waarin voor Vlaanderen de oorspronkelijke bodemcodes van de Belgische Bodemkaart werden omgezet naar de NICHE-codes via een bodemvertaalsleutel (
-`Callebaut et al. 2007 <https://pureportal.inbo.be/portal/files/5370206/Callebaut_etal_2007_NicheVlaanderen.pdf>`_). Aan elke polygoon hangt dus de juiste NICHE bodemcode (zowel letter- als cijfercode). Deze NICHE bodemkaart is beschikbaar onder de vorm van `deze shapefile <https://zenodo.org/record/5840965>`_. Uit deze shapefile kan met gepaste GIS-bewerkingen het gewenste studiegebied geknipt worden en vervolgens verrasterd met de gewenste extent en resolutie.
+`Callebaut et al. 2007 <https://pureportal.inbo.be/portal/files/5370206/Callebaut_etal_2007_NicheVlaanderen.pdf>`_). Aan elke polygoon hangt dus de juiste NICHE bodemcode (zowel letter- als cijfercode). Deze NICHE bodemkaart is beschikbaar onder de vorm van `deze shapefile <https://zenodo.org/record/5840964>`_. Uit deze shapefile kan met gepaste GIS-bewerkingen het gewenste studiegebied geknipt worden en vervolgens verrasterd met de gewenste extent en resolutie.
 De procedure om eigen bodemgegevens of een eigen bodemkaart te gebruiken wordt beschreven in het NICHE rapport (
 `Callebaut et al. 2007 <https://pureportal.inbo.be/portal/files/5370206/Callebaut_etal_2007_NicheVlaanderen.pdf>`_, hoofdstukken 3.3 *Vertaalsleutel bodemkaart* en 3.4 *Vertaalsleutel bodemprofielen*, met een gedetailleerde beschrijving van de verschillende NICHE bodemtypen, en de procedure om codes van de Bodemkaart van België of profielbeschrijvingen om te zetten naar de NICHE-codes).
 

docs/validation.ipynb

@@ -471,11 +471,11 @@
     "\n",
     "- area_effective: total area in ha with a given vegetation type, taking into account the proportion of the vegetation within each shape (pHAB)\n",
     "- nonpot: total area with actual presence according to the vegetation map, but without potential presence according to niche\n",
-    "- nonpot_phab: total area with actual presence according to the vegetation map, but without potential presence according to niche (taking pHAB into account)\n",
+    "- nonpot_phab: total area with actual presence according to the vegetation map, but without potential presence according to niche (taking pHAB into account). We recommend using nonpot_phab instead of nonpot.\n",
     "- pot: total area with actual presence according to the vegetation map and with potential presence according to niche\n",
     "- polygon count: number of shapes with the actual vegetation type according to the vegetation map. If there are few polygons, the final score should be taken with caution.\n",
     "- score: proportion of the total area with potential presence according to niche, compared to the total area of polygons with presence of a vegetation according to the vegetation map\n",
-    "- score_phab: proportion of the total area with potential presence according to niche, compared to the actual area of a vegetation type according to the vegetation map (i.e. taking pHAB into account)\n",
+    "- score_phab: proportion of the total area with potential presence according to niche, compared to the actual area of a vegetation type according to the vegetation map (i.e. taking pHAB into account). We recommend using score_phab instead of score.\n",
     "\n",
     "\n",
     "**Intermediate tables** giving values for each shape can be retrieved by their names:\n",
@@ -485,11 +485,13 @@
     "* area_nonpot: area with actual presence according to the vegetation map, but without potential presence according to niche\n",
     "* area_nonpot_phab: area with actual presence according to the vegetation map, but without potential presence according to niche (taking pHAB into account)\n",
     "  * calculated as: If([area_effective]>[area_pot];[area_effective]-[area_pot];0)\n",
+    "  * Note we recommend using area_nonpot_phab instead of area_nonpot.\n",
     "* area_pot: area with actual presence according to the vegetation map and with potential presence predicted by niche\n",
     "* area_pot_perc: proportion (%) of the area with correct predicted area (not taking into account pHAB)\n",
     "  * calculated as: 100*[area_pot]/ ([area_pot]+[area_nonpot])\n",
     "* area_pot_perc_phab: proportion (%) of the area with correct predicted area (taking into account pHAB)\n",
-    "  * calculated as: If([area_pot]<[area_effective];100*[ area_pot]/([area_effective]);100)"
+    "  * calculated as: If([area_pot]<[area_effective];100*[ area_pot]/([area_effective]);100)\n",
+    "  * Note we recommend using area_pot_perc_phab instead of area_pot_perc."
    ]
   },
   {