docs: specify return as PDF

R/network_leiden.R

@@ -29,8 +29,8 @@
 #' @param desc_hrvar Character vector of length 3 containing the HR attributes to use when returning the
 #' "describe" output. See `network_describe()`.
 #' @param return String specifying what output to return. Valid return options include:
-#'   - 'plot-leiden': return a network plot coloured by leiden communities.
-#'   - 'plot-hrvar': return a network plot coloured by HR attribute.
+#'   - 'plot-leiden': return a network plot coloured by leiden communities, saving a PDF to `path`.
+#'   - 'plot-hrvar': return a network plot coloured by HR attribute, saving a PDF to `path`.
 #'   - 'plot-sankey': return a sankey plot combining communities and HR attribute.
 #'   - 'table': return a vertex summary table with counts in communities and HR attribute.
 #'   - 'data': return a vertex data file that matches vertices with communities and HR attributes.

R/network_louvain.R

@@ -26,8 +26,8 @@
 #' "describe" output. See `network_describe()`.
 #'
 #' @param return String specifying what output to return.Valid return options include:
-#'   - 'plot-louvain': return a network plot coloured by louvain communities.
-#'   - 'plot-hrvar': return a network plot coloured by HR attribute.
+#'   - 'plot-louvain': return a network plot coloured by louvain communities, saving a PDF to `path`.
+#'   - 'plot-hrvar': return a network plot coloured by HR attribute, saving a PDF to `path`.
 #'   - 'plot-sankey': return a sankey plot combining communities and HR attribute.
 #'   - 'table': return a vertex summary table with counts in communities and HR attribute.
 #'   - 'data': return a vertex data file that matches vertices with communities and HR attributes.

man/network_leiden.Rd

@@ -45,8 +45,8 @@ if returning anything other than "plot-leiden" or "plot-hrvar".}
 
 \item{return}{String specifying what output to return. Valid return options include:
 \itemize{
-\item 'plot-leiden': return a network plot coloured by leiden communities.
-\item 'plot-hrvar': return a network plot coloured by HR attribute.
+\item 'plot-leiden': return a network plot coloured by leiden communities, saving a PDF to \code{path}.
+\item 'plot-hrvar': return a network plot coloured by HR attribute, saving a PDF to \code{path}.
 \item 'plot-sankey': return a sankey plot combining communities and HR attribute.
 \item 'table': return a vertex summary table with counts in communities and HR attribute.
 \item 'data': return a vertex data file that matches vertices with communities and HR attributes.

man/network_louvain.Rd

@@ -42,8 +42,8 @@ if returning anything other than "plot-louvain" or "plot-hrvar".}
 
 \item{return}{String specifying what output to return.Valid return options include:
 \itemize{
-\item 'plot-louvain': return a network plot coloured by louvain communities.
-\item 'plot-hrvar': return a network plot coloured by HR attribute.
+\item 'plot-louvain': return a network plot coloured by louvain communities, saving a PDF to \code{path}.
+\item 'plot-hrvar': return a network plot coloured by HR attribute, saving a PDF to \code{path}.
 \item 'plot-sankey': return a sankey plot combining communities and HR attribute.
 \item 'table': return a vertex summary table with counts in communities and HR attribute.
 \item 'data': return a vertex data file that matches vertices with communities and HR attributes.