plotcli-py 0.1.0__py3-none-any.whl

plotcli-original/man/plotcli_density.Rd

@@ -0,0 +1,44 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{plotcli_density}
+\alias{plotcli_density}
+\title{Density plot using plotcli}
+\usage{
+plotcli_density(
+  x,
+  plot_width = getOption("plotcli.plot_width", 80),
+  plot_height = getOption("plotcli.plot_height", 40),
+  x_label = "x",
+  y_label = "Density",
+  color = NULL,
+  braille = getOption("plotcli.braille", TRUE),
+  name = "density",
+  ...
+)
+}
+\arguments{
+\item{x}{A numeric vector of values}
+
+\item{plot_width}{Width of the plot (default: 80)}
+
+\item{plot_height}{Height of the plot (default: 40)}
+
+\item{x_label}{Label for the x-axis (default: "x")}
+
+\item{y_label}{Label for the y-axis (default: "Density")}
+
+\item{color}{Color of the plot elements (default: NULL)}
+
+\item{braille}{Use Braille characters for the plot (default: TRUE)}
+
+\item{name}{Name of the plot element (default: "density")}
+
+\item{...}{Additional arguments passed to the plotcli$new() function}
+}
+\description{
+Create a density plot using plotcli. Short alias: \code{pcld}.
+}
+\examples{
+x <- rnorm(100)
+plotcli_density(x)
+}

plotcli-original/man/plotcli_histogram.Rd

@@ -0,0 +1,50 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{plotcli_histogram}
+\alias{plotcli_histogram}
+\title{Histogram plot using plotcli}
+\usage{
+plotcli_histogram(
+  x,
+  plot_width = getOption("plotcli.plot_width", 80),
+  plot_height = getOption("plotcli.plot_height", 40),
+  x_label = "x",
+  y_label = "Frequency",
+  color = NULL,
+  braille = getOption("plotcli.braille", TRUE),
+  bin_width = NULL,
+  ylim = NULL,
+  name = "histogram",
+  ...
+)
+}
+\arguments{
+\item{x}{A numeric vector of values}
+
+\item{plot_width}{Width of the plot (default: 80)}
+
+\item{plot_height}{Height of the plot (default: 40)}
+
+\item{x_label}{Label for the x-axis (default: "x")}
+
+\item{y_label}{Label for the y-axis (default: "Frequency")}
+
+\item{color}{Color of the plot elements (default: NULL)}
+
+\item{braille}{Use Braille characters for the plot (default: TRUE)}
+
+\item{bin_width}{Width of the bins (default: NULL)}
+
+\item{ylim}{y limits (default: NULL)}
+
+\item{name}{Name of the plot element (default: "histogram")}
+
+\item{...}{Additional arguments passed to the plotcli$new() function}
+}
+\description{
+Create a histogram plot using plotcli. Short alias: \code{pclih}.
+}
+\examples{
+x <- rnorm(100)
+plotcli_histogram(x)
+}

plotcli-original/man/plotcli_line.Rd

@@ -0,0 +1,48 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{plotcli_line}
+\alias{plotcli_line}
+\title{Line plot using plotcli}
+\usage{
+plotcli_line(
+  y,
+  x = NULL,
+  plot_width = getOption("plotcli.plot_width", 80),
+  plot_height = getOption("plotcli.plot_height", 40),
+  x_label = "x",
+  y_label = "y",
+  color = NULL,
+  braille = getOption("plotcli.braille", TRUE),
+  name = "line",
+  ...
+)
+}
+\arguments{
+\item{y}{A numeric vector of y values}
+
+\item{x}{A numeric vector of x values}
+
+\item{plot_width}{Width of the plot (default: 80)}
+
+\item{plot_height}{Height of the plot (default: 40)}
+
+\item{x_label}{Label for the x-axis (default: "x")}
+
+\item{y_label}{Label for the y-axis (default: "y")}
+
+\item{color}{Color of the plot elements (default: NULL)}
+
+\item{braille}{Use Braille characters for the plot (default: TRUE)}
+
+\item{name}{Name of the plot element (default: "line")}
+
+\item{...}{Additional arguments passed to the plotcli$new() function}
+}
+\description{
+Create a line plot using plotcli. Short alias: \code{pcli}.
+}
+\examples{
+x <- 1:10
+y <- x^2
+plotcli_line(x, y)
+}

plotcli-original/man/plotcli_options.Rd

@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper_functions.r
+\name{plotcli_options}
+\alias{plotcli_options}
+\title{Set global options for plotcli}
+\usage{
+plotcli_options(plot_width = 60, plot_height = 20, braille = FALSE)
+}
+\arguments{
+\item{plot_width}{Default plot width (default: 60)}
+
+\item{plot_height}{Default plot height (default: 20)}
+
+\item{braille}{Default braille setting (default: FALSE)}
+}
+\description{
+Set global options for plotcli
+}

plotcli-original/man/plotcli_scatter.Rd

@@ -0,0 +1,48 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{plotcli_scatter}
+\alias{plotcli_scatter}
+\title{Scatter plot using plotcli}
+\usage{
+plotcli_scatter(
+  y,
+  x = NULL,
+  plot_width = getOption("plotcli.plot_width", 80),
+  plot_height = getOption("plotcli.plot_height", 40),
+  x_label = "x",
+  y_label = "y",
+  color = NULL,
+  braille = getOption("plotcli.braille", TRUE),
+  name = "scatter",
+  ...
+)
+}
+\arguments{
+\item{y}{A numeric vector of y values}
+
+\item{x}{A numeric vector of x values}
+
+\item{plot_width}{Width of the plot (default: 80)}
+
+\item{plot_height}{Height of the plot (default: 40)}
+
+\item{x_label}{Label for the x-axis (default: "x")}
+
+\item{y_label}{Label for the y-axis (default: "y")}
+
+\item{color}{Color of the plot elements (default: NULL)}
+
+\item{braille}{Use Braille characters for the plot (default: TRUE)}
+
+\item{name}{Name of the plot element (default: "scatter")}
+
+\item{...}{Additional arguments passed to the plotcli$new() function}
+}
+\description{
+Create a scatter plot using plotcli. Short alias: \code{pclis}.
+}
+\examples{
+x <- rnorm(100)
+y <- rnorm(100)
+plotcli_scatter(x, y)
+}

plotcli-original/man/plus-.plotcli.Rd

@@ -0,0 +1,19 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/class_functions.r
+\name{+.plotcli}
+\alias{+.plotcli}
+\title{Overload the "+" operator for plotcli objects}
+\usage{
+\method{+}{plotcli}(plot1, plot2)
+}
+\arguments{
+\item{plot1}{A plotcli object to be merged.}
+
+\item{plot2}{A plotcli object to be merged.}
+}
+\value{
+A new plotcli object containing the combined data from both objects.
+}
+\description{
+This function overloads the "+" operator to merge two plotcli objects.
+}

plotcli-original/man/rbind.plotcli.Rd

@@ -0,0 +1,19 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/class_functions.r
+\name{rbind.plotcli}
+\alias{rbind.plotcli}
+\title{Generic function for combining plotcli objects vertically}
+\usage{
+\method{rbind}{plotcli}(..., deparse.level = 1)
+}
+\arguments{
+\item{...}{plotcli objects to be combined.}
+
+\item{deparse.level}{The deparsing level for the arguments.}
+}
+\value{
+A combined plot matrix.
+}
+\description{
+Generic function for combining plotcli objects vertically
+}

plotcli-original/man/rbind_plots.Rd

@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/class_functions.r
+\name{rbind_plots}
+\alias{rbind_plots}
+\title{Combine plot matrices vertically}
+\usage{
+rbind_plots(...)
+}
+\arguments{
+\item{...}{A list of plot matrices to be combined.}
+}
+\value{
+A combined plot matrix.
+}
+\description{
+This function combines multiple plot matrices vertically, centering them horizontally.
+}

plotcli-original/man/register_geom.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{register_geom}
+\alias{register_geom}
+\title{Register a Geom Handler}
+\usage{
+register_geom(geom_name, handler)
+}
+\arguments{
+\item{geom_name}{Name of the geom (e.g., "GeomPoint", "GeomLine")}
+
+\item{handler}{Function that takes (data, canvas, scales, params) and draws to canvas}
+}
+\description{
+Register a function that can render a specific ggplot2 geom to a canvas.
+}
+\examples{
+register_geom("GeomPoint", function(data, canvas, scales, params) {
+  # Draw points on canvas
+})
+}

plotcli-original/man/remove_color_codes.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper_functions.r
+\name{remove_color_codes}
+\alias{remove_color_codes}
+\title{Remove color codes from a string}
+\usage{
+remove_color_codes(s)
+}
+\arguments{
+\item{s}{The text string containing ANSI color codes.}
+}
+\value{
+A text string with ANSI color codes removed.
+}
+\description{
+This function removes ANSI color codes from a given text string.
+}
+\examples{
+colored_text <- make_colored("Hello, world!", "blue")
+remove_color_codes(colored_text)
+}

plotcli-original/man/render_faceted_plot.Rd

@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{render_faceted_plot}
+\alias{render_faceted_plot}
+\title{Render Faceted Plot}
+\usage{
+render_faceted_plot(built, facet_info, width, height, canvas_type, style_opts)
+}
+\arguments{
+\item{built}{Result from ggplot_build}
+
+\item{facet_info}{Facet information from get_facet_info}
+
+\item{width}{Total width}
+
+\item{height}{Total height}
+
+\item{canvas_type}{Canvas type}
+
+\item{style_opts}{Style options}
+}
+\description{
+Render Faceted Plot
+}
+\keyword{internal}

plotcli-original/man/render_single_panel.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{render_single_panel}
+\alias{render_single_panel}
+\title{Render a single panel (non-faceted) plot}
+\usage{
+render_single_panel(built, width, height, canvas_type, style_opts)
+}
+\description{
+Render a single panel (non-faceted) plot
+}
+\keyword{internal}

plotcli-original/man/safe_aes_name.Rd

@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli.r
+\name{safe_aes_name}
+\alias{safe_aes_name}
+\title{Safely extract aesthetic name from ggplot mapping}
+\usage{
+safe_aes_name(aes_expr)
+}
+\arguments{
+\item{aes_expr}{The aesthetic expression (can be a quosure)}
+}
+\value{
+Character string of the column name, or NULL
+}
+\description{
+Handles quosures, simple symbols, and calls like factor(cyl)
+}
+\keyword{internal}

plotcli-original/tests/testthat/test-new-geoms.R

@@ -0,0 +1,136 @@
+library(testthat)
+library(plotcli)
+library(ggplot2)
+
+test_that("GeomTile works", {
+  df_tile <- expand.grid(x = 1:5, y = 1:5)
+  df_tile$z <- runif(25)
+  p <- ggplot(df_tile, aes(x, y, fill = z)) + geom_tile()
+
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomPolygon warns about missing handler", {
+  ids <- factor(c("1.1", "2.1", "1.2", "2.2", "1.3", "2.3"))
+  values <- data.frame(
+    id = ids,
+    value = c(3, 3.1, 3.1, 3.2, 3.15, 3.5)
+  )
+  positions <- data.frame(
+    id = rep(ids, each = 4),
+    x = c(2, 1, 1.1, 2.2, 1, 0, 0.3, 1.1, 2.2, 1.1, 1.2, 2.5, 1.1, 0.3, 0.5, 1.2, 2.5, 1.2, 1.3, 2.7, 1.2, 0.5, 0.6, 1.3),
+    y = c(-0.5, 0, 1, 0.5, 0, 0.5, 1.5, 1, 0.5, 1, 2.1, 1.7, 1, 1.5, 2.2, 2.1, 1.7, 2.1, 3.2, 2.8, 2.1, 2.2, 3.3, 3.2)
+  )
+  datapoly <- merge(values, positions, by = c("id"))
+  p <- ggplot(datapoly, aes(x = x, y = y)) + geom_polygon(aes(fill = value, group = id))
+
+  expect_warning(res <- ggplotcli(p), "No handler registered for geom: GeomPolygon")
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("Faceting works", {
+  p <- ggplot(mtcars, aes(x = mpg, y = wt)) +
+    geom_point() +
+    facet_wrap(~ cyl)
+
+  expect_output(res <- ggplotcli(p))
+})
+
+test_that("GeomBar works", {
+  p <- ggplot(mtcars, aes(x = factor(cyl))) + geom_bar()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomStep works", {
+  df <- data.frame(x = 1:10, y = cumsum(rnorm(10)))
+  p <- ggplot(df, aes(x, y)) + geom_step()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomAbline works", {
+  p <- ggplot(mtcars, aes(wt, mpg)) + geom_point() +
+    geom_abline(intercept = 37, slope = -5, color = "red")
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomRibbon works", {
+  df <- data.frame(x = 1:20, y = sin(1:20 / 3),
+                   ymin = sin(1:20 / 3) - 0.5, ymax = sin(1:20 / 3) + 0.5)
+  p <- ggplot(df, aes(x, y)) +
+    geom_ribbon(aes(ymin = ymin, ymax = ymax), fill = "steelblue") +
+    geom_line()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomSmooth with ribbon works", {
+  p <- ggplot(mtcars, aes(wt, mpg)) + geom_point() +
+    geom_smooth(method = "lm")
+  expect_output(res <- suppressMessages(ggplotcli(p)))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomErrorbar works", {
+  df <- data.frame(x = 1:5, y = c(2, 4, 3, 5, 4),
+                   ymin = c(1, 3, 2, 4, 3), ymax = c(3, 5, 4, 6, 5))
+  p <- ggplot(df, aes(x, y, ymin = ymin, ymax = ymax)) +
+    geom_errorbar(width = 0.3) + geom_point()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomLinerange works", {
+  df <- data.frame(x = 1:5, y = c(2, 4, 3, 5, 4),
+                   ymin = c(1, 3, 2, 4, 3), ymax = c(3, 5, 4, 6, 5))
+  p <- ggplot(df, aes(x, y, ymin = ymin, ymax = ymax)) + geom_linerange()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomPointrange works", {
+  df <- data.frame(x = 1:5, y = c(2, 4, 3, 5, 4),
+                   ymin = c(1, 3, 2, 4, 3), ymax = c(3, 5, 4, 6, 5))
+  p <- ggplot(df, aes(x, y, ymin = ymin, ymax = ymax)) + geom_pointrange()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomCrossbar works", {
+  df <- data.frame(x = 1:5, y = c(2, 4, 3, 5, 4),
+                   ymin = c(1, 3, 2, 4, 3), ymax = c(3, 5, 4, 6, 5))
+  p <- ggplot(df, aes(x, y, ymin = ymin, ymax = ymax)) +
+    geom_crossbar(fill = "lightblue")
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomRug works", {
+  p <- ggplot(mtcars, aes(wt, mpg)) + geom_point() + geom_rug()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomLabel works", {
+  df <- data.frame(x = c(1, 2, 3), y = c(3, 1, 2), lab = c("A", "B", "C"))
+  p <- ggplot(df, aes(x, y, label = lab)) + geom_label()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomRaster works", {
+  df <- expand.grid(x = 1:10, y = 1:10)
+  df$z <- runif(100)
+  p <- ggplot(df, aes(x, y, fill = z)) + geom_raster()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})
+
+test_that("GeomViolin works", {
+  p <- ggplot(mtcars, aes(factor(cyl), mpg)) + geom_violin()
+  expect_output(res <- ggplotcli(p))
+  expect_s3_class(res, "Canvas")
+})

plotcli-original/tests/testthat/test-plotcli.R

@@ -0,0 +1,69 @@
+library(testthat)
+library(plotcli)
+
+test_that("plotcli_density works", {
+  sample_data <- rnorm(1000, mean = 5, sd = 2)
+  expect_silent(plotcli_density(sample_data, color = "blue", braille = TRUE))
+})
+
+test_that("plotcli_histogram works", {
+  sample_data <- rnorm(1000, mean = 5, sd = 2)
+  expect_silent(plotcli_histogram(sample_data, color = "yellow"))
+})
+
+test_that("plotcli_scatter works", {
+  expect_silent(plotcli_scatter(x = iris$Sepal.Width, y = iris$Sepal.Length, color = "magenta", braille = FALSE))
+})
+
+test_that("plotcli_line works", {
+  x <- seq(0, 2*pi, length.out = 50)
+  y <- sin(x)
+  expect_silent(plotcli_line(x = x, y = cos(y), color = "green"))
+  expect_silent(plotcli_line(x = x, y = x, color = "magenta", braille = FALSE))
+})
+
+test_that("plotcli R6 class works", {
+  plot_width = 80
+  plot_height = 40
+  x <- seq(0, 2 * pi, length.out = 100)
+  y1 <- sin(x)
+  y2 <- cos(x)
+
+  data_1 = list(x = x, y = y1, name = "y1 = sin(x)", color = "blue", type = "line", braille = FALSE)
+  data_2 = list(x = x, y = y2, name = "y2 = cos(x)", color = "red", type = "line", braille = FALSE)
+
+  plot <- plotcli$new(plot_width = plot_width, plot_height = plot_height, x_label = "X-axis", y_label = "Y-axis")
+  expect_silent(plot$add_data(data_1))
+  expect_silent(plot$add_data(data_2))
+  expect_output(plot$print_plot())
+})
+
+test_that("constant y-values do not error", {
+  x <- seq(0, 10, length.out = 50)
+  y <- rep(1.0, length(x))
+  expect_output(plotcli_line(x = x, y = y)$print_plot())
+  expect_output(plotcli_line(x = x, y = y, braille = TRUE)$print_plot())
+  expect_silent(plotcli_scatter(x = x, y = y))
+  expect_silent(plotcli_scatter(x = x, y = y, braille = TRUE))
+})
+
+test_that("constant x-values do not error", {
+  x <- rep(5, 50)
+  y <- seq(0, 10, length.out = 50)
+  expect_output(plotcli_line(x = x, y = y)$print_plot())
+  expect_silent(plotcli_scatter(x = x, y = y))
+})
+
+test_that("constant x and y values do not error", {
+  x <- rep(3, 50)
+  y <- rep(7, 50)
+  expect_output(plotcli_line(x = x, y = y)$print_plot())
+  expect_silent(plotcli_scatter(x = x, y = y))
+})
+
+test_that("constant zero values do not error", {
+  x <- seq(0, 10, length.out = 50)
+  y <- rep(0, length(x))
+  expect_output(plotcli_line(x = x, y = y)$print_plot())
+  expect_silent(plotcli_scatter(x = x, y = y))
+})

plotcli-original/tests/testthat.R

@@ -0,0 +1,4 @@
+library(testthat)
+library(plotcli)
+
+test_check("plotcli")