Skip to content

Commit 271be73

Browse files
committed
more docs
1 parent cbc7247 commit 271be73

File tree

6 files changed

+64
-10
lines changed

6 files changed

+64
-10
lines changed

NAMESPACE

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ importFrom(SummarizedExperiment,colData)
5454
importFrom(anndataR,read_zarr)
5555
importFrom(arrow,open_dataset)
5656
importFrom(grDevices,col2rgb)
57+
importFrom(grDevices,colorRampPalette)
58+
importFrom(grDevices,rainbow)
5759
importFrom(grDevices,rgb)
5860
importFrom(methods,as)
5961
importFrom(methods,is)

R/plot-image.R

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
#' @name sd_plot_image
22
#' @title Plot `ImageArray`
33
#'
4+
#' @param x \code{\link{SpatialData}} object.
5+
#' @param i scalar integer or string;
6+
#' specifies which \code{images} to plot.
7+
#' @param k resolution; if NULL (default), picking
8+
#' best for given \code{w}idth and \code{h}eight.
9+
#' @param c character vector of colors to use;
10+
#' if NULL (default), using \code{rainbow()}.
11+
#' @param ch integer or character vector
12+
#' specifying which channels to render.
13+
#' @param cl list of channel-wise contrast limits.
14+
#' @param w,h render width and height in pixel.
15+
#'
416
#' @return \code{ggplot}
517
#'
618
#' @examples

R/plot-label.R

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
#' @name sd_plot_label
22
#' @title Plot `LabelArray`
33
#'
4+
#' @param x \code{\link{SpatialData}} object.
5+
#' @param i scalar integer or string;
6+
#' specifies which \code{labels} to plot.
7+
#' @param k resolution; if NULL (default), picking
8+
#' best for given \code{w}idth and \code{h}eight.
9+
#' @param c character vector of colors to use;
10+
#' if NULL (default), using \code{rainbow()}.
11+
#' @param w,h render width and height in pixel.
12+
#'
413
#' @return \code{ggplot}
514
#'
615
#' @examples
@@ -14,8 +23,7 @@
1423
#' @importFrom DelayedArray realize
1524
#' @importFrom grDevices rgb rainbow colorRampPalette
1625
#' @export
17-
sd_plot_label <- \(x, i=1, k=NULL, c=NULL, w=800, h=800, ...) {
18-
c <- pal
26+
sd_plot_label <- \(x, i=1, k=NULL, c=NULL, w=800, h=800) {
1927
la <- x@labels[[i]]
2028
if (is.null(k))
2129
k <- .guess_scale(la, w, h)

man/sd_data.Rd

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

man/sd_plot_image.Rd

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

man/sd_plot_label.Rd

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

0 commit comments

Comments
 (0)