Merge pull request #119 from Circuitscape/vl/issue116

closes #116 -- docs typo fixes
Circuitscape · Jun 3, 2022 · ab45182 · ab45182
2 parents fd79f0e + 946ec15
commit ab45182
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/src/examples.md b/docs/src/examples.md
@@ -128,7 +128,7 @@ plot(fp,
 <img src='../figs/md-fp.png' width=500> <br><em>Flow potential, which shows what connectivity would look like in the absence of barriers to movement. The blocking that you can see is an artifact of setting a large block_size to make the example run faster. Set a smaller block_size to reduce/remove this issue.</em><br><br>
 ```
 
-Finally, map normalized current flow, which is calculated as flow potential divided by cumulative current.
+Finally, map normalized current flow, which is calculated as cumulative current divided by flow potential.
 
 ```julia
 normalized_current = Raster("md_nlcd_omniscape_output/normalized_cum_currmap.tif")

diff --git a/docs/src/usage.md b/docs/src/usage.md
@@ -158,7 +158,7 @@ Example reclass_table.txt:
 
 #### Output Options
 
-**`write_raw_currmap`:** One of true, false. Defaults to true. Save the raw cumulative current map to disk? Should always be set to true unless `calc_flow_potential`, `calc_normalized_current`, or both are true and you do not need the raw current output. If true, the cumulative current map is saved to disk as a raster called "flow_potential" with either a .tif or .asc extension (see `write_as_tif` below) in the `project_name` directory.
+**`write_raw_currmap`:** One of true, false. Defaults to true. Save the raw cumulative current map to disk? Should always be set to true unless `calc_flow_potential`, `calc_normalized_current`, or both are true and you do not need the raw current output. If true, the cumulative current map is saved to disk as a raster called "cum_currmap" with either a .tif or .asc extension (see `write_as_tif` below) in the `project_name` directory.
 
 **`mask_nodata`:** One of true, false. Defaults to true. Specify whether to mask current flow outputs according to NoData values in resistance surface. (i.e. pixels in current flow outputs that line up with NoData values in resistance are set to no data if `mask_nodata` = true).