Skip to content

Commit 92d88b5

Browse files
committed
typo plot_signal
1 parent ec7e6a9 commit 92d88b5

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

R/plot_signal.R

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
#' Visualize a signal over a graph.
44
#'
55
#'@details
6-
#' This function allows visualization of a graph signal \code{f} superimposed on the structure of a graph defined by \code{z}. It offers an intuitive way to analyze the behavior of graph signals in the vertex domain. The appearance of the colorbar can be customized by passing additional arguments that are available for \code{ggplot2::guide-colourbar}.
6+
#' This function allows visualization of a graph signal \code{f} superimposed on the structure of a graph defined by \code{z}. It offers an intuitive way to analyze the behavior of graph signals in the vertex domain. The appearance of the colorbar can be customized by passing additional arguments that are available for \code{ggplot2::guide_colourbar}.
77
#'
88
#'@note If node coordinates \code{xy} are not provided, they will be calculated using spectral methods \code{\link{spectral_coords}}. For large graphs, this can be computationally intensive and may take significant time. Use with caution for large graphs if node coordinates are not supplied.
99
#'
1010
#' @export plot_signal
1111
#' @importFrom methods is
1212
#' @importFrom Matrix summary
1313
#' @param z A list containing graph data. This list must have the following components:
14-
#' \itemize{
15-
#' \item{sA} An adjacency matrix or a sparse Matrix representation of the graph.
16-
#' \item{xy} A matrix or dataframe containing the x and y coordinates of each node in the graph.
17-
#' }
14+
#' \itemize{
15+
#' \item{sA} An adjacency matrix or a sparse Matrix representation of the graph.
16+
#' \item{xy} A matrix or dataframe containing the x and y coordinates of each node in the graph.
17+
#' }
1818
#' @param f Signal to plot.
1919
#' @param size Numeric. Dot size for nodes. Default is 0.75.
2020
#' @param limits Set colormap limits.

man/plot_signal.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)