add more documentation (plotting)

Author: lschneiderbauer

R/autoplot.R

@@ -1,3 +1,17 @@
+#' Create ggplot for a CVRP solution
+#'
+#' The individual runs are distinguished by color.
+#' The demanding site locations are marked with round circles while the
+#' (single) supplying site is depicted as a square.
+#' The line types (solid/dashed/...) are associated to different vehicle types.
+#'
+#' @param object
+#'  A "`heumilkr_solution`" object, typically obtained by [clarke_wright()].
+#'
+#' @param ... Not used.
+#'
+#' @return A ggplot object.
+#'
 #' @importFrom ggplot2 autoplot ggplot aes geom_point geom_path
 #'                              scale_color_discrete
 #'                              scale_shape_identity
@@ -32,6 +46,12 @@ autoplot.heumilkr_solution <- function(object, ...) {
     theme(legend.position = "none")
 }
 
+#' Plot a CVRP solution
+#'
+#' @param x
+#'  A "`heumilkr_solution`" object, typically obtained by [clarke_wright()].
+#' @inheritParams autoplot.heumilkr_solution
+#'
 #' @importFrom graphics plot
 #' @export
 plot.heumilkr_solution <- function(x, ...) {

_pkgdown.yml

@@ -8,6 +8,9 @@ reference:
     input or to CVRPLIB instance data
   contents:
   - starts_with("clarke_wright")
+- title: "Plotting"
+  - autoplot.heumilkr_solution
+  - plot.heumilkr_solution
 - title: "Costs and Savings"
   desc: >
     Helper functions to retrieve costs as well as savings from CVRP solutions