Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
see24 committed Mar 12, 2024
1 parent 2ffc91e commit 46c5a61
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 32 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Imports:
methods,
tidyselect,
terra
RoxygenNote: 7.2.1
RoxygenNote: 7.2.3
Suggests:
testthat (>= 2.1.0),
knitr,
Expand Down
6 changes: 3 additions & 3 deletions R/projectRoads.R
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
#' cells with a cost of 0. If existing roads do not have 0 cost set
#' \code{roadsInCost = FALSE} and they will be burned in.
#' @param roads sf lines, SpatialLines*, RasterLayer. Existing road network.
#' @param roadMethod Character. Options are "mst", "ilcp", "lcp", "snap".
#' @param roadMethod Character. Options are "ilcp", "mst", "lcp", "snap".
#' @param plotRoads Boolean. Should the resulting road network be plotted.
#' Default FALSE.
#' @param mainTitle Character. A title for the plot
Expand Down Expand Up @@ -96,14 +96,14 @@
#'
#' demoScen <- prepExData(demoScen)
#'
#' ### using: scenario 1 / sf landings / least-cost path ("lcp")
#' ### using: scenario 1 / sf landings / iterative least-cost path ("ilcp")
#' # demo scenario 1
#' scen <- demoScen[[1]]
#'
#' # landing set 1 of scenario 1:
#' land.pnts <- scen$landings.points[scen$landings.points$set==1,]
#'
#' prRes <- projectRoads(land.pnts, scen$cost.rast, scen$road.line, "lcp",
#' prRes <- projectRoads(land.pnts, scen$cost.rast, scen$road.line, "ilcp",
#' plotRoads = doPlots, mainTitle = "Scen 1: SPDF-LCP")
#'
#' ### using: scenario 1 / SpatRaster landings / minimum spanning tree ("mst")
Expand Down
41 changes: 21 additions & 20 deletions man/getDistFromSource.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions man/projectRoads.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 46c5a61

Please sign in to comment.