Skip to content

Commit 8bd1eb5

Browse files
committed
Push old README version
1 parent c7169e1 commit 8bd1eb5

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Rkeyline
1+
# Rkeyline <img src="man/figures/logo.png" align="right" height="139"/>
22

33
**Rkeyline** is an R package to support desktop keyline design planning and terrain analysis from Digital Elevation Models (DTMs). It provides a complete workflow from raw DTM data to approximate keyline design, covering geomorphological analysis, valley and ridge network extraction, and visualization.
44

5-
**Note:** Generated keylines are computational approximations for desktop planning only. Always verify and adjust keylines on-site with an experienced practitioner before implementation.
5+
> **Note:** Generated keylines are computational approximations for desktop planning only. Always verify and adjust keylines on-site with an experienced practitioner before implementation.
66
77
---
88

@@ -34,7 +34,7 @@ whitebox::install_whitebox()
3434

3535
Several functions use WhiteboxTools under the hood, which requires intermediate files to be written to disk. **You must specify an `output_folder` that exists and is writable on your system.** Both `calc_geomorph_metrics()` and `extract_networks()` need access to the same folder — files written in Step 2 are read again in Step 3.
3636

37-
**Note:** Do not rely on the default `tempdir()`. Temporary directories are cleared when your R session ends, so if you restart R between steps the intermediate files will be gone and `extract_networks()` will fail. Always set a persistent folder explicitly.
37+
> **Note:**: Do not rely on the default `tempdir()`. Temporary directories are cleared when your R session ends, so if you restart R between steps the intermediate files will be gone and `extract_networks()` will fail. Always set a persistent folder explicitly.
3838
3939
```r
4040
# Set once and reuse throughout the entire workflow
@@ -150,7 +150,7 @@ All plot functions accept pre-calculated metrics for efficiency.
150150
plot_dtm_contours(dtm, metrics = metrics)
151151
```
152152

153-
![DTM with contours](https://raw.githubusercontent.com/Lenaelu/Rkeyline/main/img_folder/plot_dtm_contours.png)
153+
![DTM with contours](img_folder/plot_dtm_contours.png)
154154

155155
---
156156

@@ -160,7 +160,7 @@ plot_dtm_contours(dtm, metrics = metrics)
160160
plot_slope_channels(dtm, metrics = metrics)
161161
```
162162

163-
![Slope with channels](https://raw.githubusercontent.com/Lenaelu/Rkeyline/main/img_folder/plot_slope_channels.png)
163+
![Slope with channels](img_folder/plot_slope_channels.png)
164164

165165
---
166166

@@ -170,9 +170,9 @@ plot_slope_channels(dtm, metrics = metrics)
170170
plot_flow_acc(dtm, metrics = metrics)
171171
```
172172

173-
![Flow accumulation](https://raw.githubusercontent.com/Lenaelu/Rkeyline/main/img_folder/plot_flow_acc.png)
173+
![Flow accumulation](img_folder/plot_flow_acc.png)
174174

175-
**Note:** In the package this is fully interactive — toggle layers and adjust opacity via a Shiny app.
175+
> **Note:** In the package this is fully interactive — toggle layers and adjust opacity via a Shiny app.
176176
177177
---
178178

@@ -198,7 +198,7 @@ plot_main_networks(dtm, main_ridges = main_ridges, metrics = metrics)
198198
plot_main_networks(dtm, main_valleys = main_valleys, main_ridges = main_ridges, metrics = metrics)
199199
```
200200

201-
![Main networks](https://raw.githubusercontent.com/Lenaelu/Rkeyline/main/img_folder/plot_main_networks.png)
201+
![Main networks](img_folder/plot_main_networks.png)
202202

203203
---
204204

@@ -208,7 +208,7 @@ plot_main_networks(dtm, main_valleys = main_valleys, main_ridges = main_ridges,
208208
plot_keylines(dtm, metrics = metrics, keylines = valley_keylines)
209209
```
210210

211-
![Keylines](https://raw.githubusercontent.com/Lenaelu/Rkeyline/main/img_folder/plot_keylines.png)
211+
![Keylines](img_folder/plot_keylines.png)
212212

213213
---
214214

0 commit comments

Comments
 (0)