plotcli-py 0.1.0__py3-none-any.whl

plotcli-original/man/cbind_plots.Rd

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

plotcli-original/man/color_to_term.Rd

@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{color_to_term}
+\alias{color_to_term}
+\title{Convert ggplot2 color to terminal color name}
+\usage{
+color_to_term(color)
+}
+\arguments{
+\item{color}{A color value (hex, name, or R color)}
+}
+\value{
+A terminal color name (blue, red, green, etc.) or NULL
+}
+\description{
+If init_color_mapping() was called, uses the pre-computed mapping.
+Otherwise falls back to simple hue-based matching.
+}

plotcli-original/man/create_canvas.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/canvas.r
+\name{create_canvas}
+\alias{create_canvas}
+\title{Create a canvas of the specified type}
+\usage{
+create_canvas(width, height, type = "braille")
+}
+\arguments{
+\item{width}{Character width}
+
+\item{height}{Character height}
+
+\item{type}{Canvas type: "ascii", "braille", or "block"}
+}
+\value{
+A Canvas object
+}
+\description{
+Create a canvas of the specified type
+}

plotcli-original/man/create_panel_scales.Rd

@@ -0,0 +1,29 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{create_panel_scales}
+\alias{create_panel_scales}
+\title{Create Scales for a Single Panel}
+\usage{
+create_panel_scales(panel_params, plot_width, plot_height,
+  has_border = FALSE, x_mult = 1, y_mult = 1)
+}
+\arguments{
+\item{panel_params}{Panel parameters from ggplot_build}
+
+\item{plot_width}{Pixel width}
+
+\item{plot_height}{Pixel height}
+
+\item{has_border}{Whether a border will be drawn (adds padding)}
+
+\item{x_mult}{X multiplier for canvas type (e.g., 2 for braille)}
+
+\item{y_mult}{Y multiplier for canvas type (e.g., 4 for braille)}
+}
+\value{
+List with scale functions
+}
+\description{
+Create Scales for a Single Panel
+}
+\keyword{internal}

plotcli-original/man/create_scales.Rd

@@ -0,0 +1,27 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{create_scales}
+\alias{create_scales}
+\title{Create Scale Object from ggplot_build data}
+\usage{
+create_scales(built, plot_width, plot_height, has_border = FALSE, x_mult = 1, y_mult = 1)
+}
+\arguments{
+\item{built}{Result from ggplot_build()}
+
+\item{plot_width}{Canvas pixel width}
+
+\item{plot_height}{Canvas pixel height}
+
+\item{has_border}{Whether a border will be drawn (adds padding)}
+
+\item{x_mult}{X multiplier for canvas type (e.g., 2 for braille)}
+
+\item{y_mult}{Y multiplier for canvas type (e.g., 4 for braille)}
+}
+\value{
+List with x_scale and y_scale functions
+}
+\description{
+Create Scale Object from ggplot_build data
+}

plotcli-original/man/dot-geom_registry.Rd

@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\docType{data}
+\name{.geom_registry}
+\alias{.geom_registry}
+\title{Geom Registry Environment}
+\format{
+An object of class \code{environment} of length 15.
+}
+\usage{
+.geom_registry
+}
+\description{
+Internal environment storing registered geom handlers
+}
+\keyword{internal}

plotcli-original/man/draw_border.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{draw_border}
+\alias{draw_border}
+\title{Draw Border Around Canvas}
+\usage{
+draw_border(canvas)
+}
+\description{
+Draw Border Around Canvas
+}
+\keyword{internal}

plotcli-original/man/draw_grid.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{draw_grid}
+\alias{draw_grid}
+\title{Draw Grid Lines on Canvas}
+\usage{
+draw_grid(canvas, scales, grid_type)
+}
+\description{
+Draw Grid Lines on Canvas
+}
+\keyword{internal}

plotcli-original/man/extract_legend_info.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{extract_legend_info}
+\alias{extract_legend_info}
+\title{Extract Legend Information from ggplot}
+\usage{
+extract_legend_info(built)
+}
+\description{
+Extract Legend Information from ggplot
+}
+\keyword{internal}

plotcli-original/man/extract_plot_labels.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{extract_plot_labels}
+\alias{extract_plot_labels}
+\title{Extract Plot Labels from ggplot}
+\usage{
+extract_plot_labels(built, title, subtitle, caption, axis_labels)
+}
+\description{
+Extract Plot Labels from ggplot
+}
+\keyword{internal}

plotcli-original/man/extract_plot_style.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{extract_plot_style}
+\alias{extract_plot_style}
+\title{Extract Plot Style from ggplot Theme}
+\usage{
+extract_plot_style(built, border, grid, legend)
+}
+\description{
+Extract Plot Style from ggplot Theme
+}
+\keyword{internal}

plotcli-original/man/format_axis_label.Rd

@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{format_axis_label}
+\alias{format_axis_label}
+\title{Format Axis Label}
+\usage{
+format_axis_label(value)
+}
+\arguments{
+\item{value}{Numeric value}
+}
+\value{
+Formatted string
+}
+\description{
+Format Axis Label
+}
+\keyword{internal}

plotcli-original/man/format_four_chars.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper_functions.r
+\name{format_four_chars}
+\alias{format_four_chars}
+\title{Format number to four characters}
+\usage{
+format_four_chars(num)
+}
+\arguments{
+\item{num}{The number to be formatted.}
+}
+\value{
+A string representation of the number with exactly four characters.
+}
+\description{
+This function formats a number to a string of exactly four characters.
+}
+\examples{
+format_four_chars(123)
+format_four_chars(-12.34)
+}

plotcli-original/man/geom_area_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_area_handler}
+\alias{geom_area_handler}
+\title{GeomArea Handler}
+\usage{
+geom_area_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders filled areas
+}
+\keyword{internal}

plotcli-original/man/geom_bar_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_bar_handler}
+\alias{geom_bar_handler}
+\title{GeomBar/GeomCol Handler}
+\usage{
+geom_bar_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders bar charts
+}
+\keyword{internal}

plotcli-original/man/geom_boxplot_handler.Rd

@@ -0,0 +1,13 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_boxplot_handler}
+\alias{geom_boxplot_handler}
+\title{GeomBoxplot Handler}
+\usage{
+geom_boxplot_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders boxplots with whiskers, box, median line, and outliers.
+Supports two styles: "ascii" (box-drawing characters) and "braille" (Braille dots).
+}
+\keyword{internal}

plotcli-original/man/geom_density_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_density_handler}
+\alias{geom_density_handler}
+\title{GeomDensity Handler}
+\usage{
+geom_density_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders density curves
+}
+\keyword{internal}

plotcli-original/man/geom_histogram_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_histogram_handler}
+\alias{geom_histogram_handler}
+\title{GeomHistogram Handler}
+\usage{
+geom_histogram_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders histograms (same as bar)
+}
+\keyword{internal}

plotcli-original/man/geom_hline_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_hline_handler}
+\alias{geom_hline_handler}
+\title{GeomHline Handler}
+\usage{
+geom_hline_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders horizontal lines
+}
+\keyword{internal}

plotcli-original/man/geom_line_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_line_handler}
+\alias{geom_line_handler}
+\title{GeomLine Handler}
+\usage{
+geom_line_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders connected lines
+}
+\keyword{internal}

plotcli-original/man/geom_path_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_path_handler}
+\alias{geom_path_handler}
+\title{GeomPath Handler}
+\usage{
+geom_path_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders connected paths (order by data, not x)
+}
+\keyword{internal}

plotcli-original/man/geom_point_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_point_handler}
+\alias{geom_point_handler}
+\title{GeomPoint Handler}
+\usage{
+geom_point_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders points as individual pixels or small shapes
+}
+\keyword{internal}

plotcli-original/man/geom_rect_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_rect_handler}
+\alias{geom_rect_handler}
+\title{GeomRect Handler}
+\usage{
+geom_rect_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders rectangles
+}
+\keyword{internal}

plotcli-original/man/geom_segment_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_segment_handler}
+\alias{geom_segment_handler}
+\title{GeomSegment Handler}
+\usage{
+geom_segment_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders line segments
+}
+\keyword{internal}

plotcli-original/man/geom_smooth_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_smooth_handler}
+\alias{geom_smooth_handler}
+\title{GeomSmooth Handler}
+\usage{
+geom_smooth_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders smoothed lines (just draws the line, ignores confidence interval)
+}
+\keyword{internal}

plotcli-original/man/geom_text_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_text_handler}
+\alias{geom_text_handler}
+\title{GeomText Handler}
+\usage{
+geom_text_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders text labels
+}
+\keyword{internal}

plotcli-original/man/geom_vline_handler.Rd

@@ -0,0 +1,12 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{geom_vline_handler}
+\alias{geom_vline_handler}
+\title{GeomVline Handler}
+\usage{
+geom_vline_handler(data, canvas, scales, params, style_opts = NULL)
+}
+\description{
+Renders vertical lines
+}
+\keyword{internal}

plotcli-original/man/get_color_hue.Rd

@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{get_color_hue}
+\alias{get_color_hue}
+\title{Get the hue of a color (0-360 degrees)}
+\usage{
+get_color_hue(color)
+}
+\arguments{
+\item{color}{A color value}
+}
+\value{
+Hue in degrees (0-360) or NA for grayscale
+}
+\description{
+Get the hue of a color (0-360 degrees)
+}
+\keyword{internal}

plotcli-original/man/get_data_subset.Rd

@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli.r
+\name{get_data_subset}
+\alias{get_data_subset}
+\title{Get data subset for a specific geom}
+\usage{
+get_data_subset(geom_name, data, aes, p_build)
+}
+\arguments{
+\item{geom_name}{The name of the geom for which the data subset is needed.}
+
+\item{data}{The data to be subsetted.}
+
+\item{aes}{The aesthetic mappings for the geom.}
+
+\item{p_build}{The ggplot build object.}
+}
+\value{
+A list containing the data subset for the specified geom.
+}
+\description{
+This function returns a subset of the data for a specific geom.
+}

plotcli-original/man/get_facet_info.Rd

@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli_helpers.r
+\name{get_facet_info}
+\alias{get_facet_info}
+\title{Get Facet Information from Layout}
+\usage{
+get_facet_info(layout)
+}
+\arguments{
+\item{layout}{The layout object from ggplot_build}
+}
+\value{
+List with facet info
+}
+\description{
+Get Facet Information from Layout
+}
+\keyword{internal}

plotcli-original/man/get_geom_handler.Rd

@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{get_geom_handler}
+\alias{get_geom_handler}
+\title{Get a Geom Handler}
+\usage{
+get_geom_handler(geom_name)
+}
+\arguments{
+\item{geom_name}{Name of the geom}
+}
+\value{
+The handler function or NULL
+}
+\description{
+Retrieve the registered handler for a geom, or NULL if not found.
+}

plotcli-original/man/get_term_colors.Rd

@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper_functions.r
+\name{get_term_colors}
+\alias{get_term_colors}
+\title{Get terminal colors}
+\usage{
+get_term_colors(n = NULL)
+}
+\arguments{
+\item{n}{The number of colors to return.}
+}
+\value{
+A vector of terminal colors.
+}
+\description{
+This function returns a vector of terminal colors.
+}
+\examples{
+get_term_colors(5)
+get_term_colors(10)
+}

plotcli-original/man/ggplotcli.Rd

@@ -0,0 +1,83 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/ggplotcli.r
+\name{ggplotcli}
+\alias{ggplotcli}
+\title{ggplotcli - Render ggplot2 objects in the terminal}
+\usage{
+ggplotcli(
+  p,
+  width = 60,
+  height = 20,
+  canvas_type = "braille",
+  border = "auto",
+  grid = "none",
+  show_axes = TRUE,
+  axis_labels = TRUE,
+  legend = "auto",
+  title_align = "center",
+  subtitle = TRUE,
+  caption = TRUE,
+  title = NULL,
+  boxplot_style = "ascii"
+)
+}
+\arguments{
+\item{p}{A ggplot2 object to render}
+
+\item{width}{Character width of the plot (default: 60)}
+
+\item{height}{Character height of the plot (default: 20)}
+
+\item{canvas_type}{Type of canvas: "braille" (high-res), "block" (medium), or "ascii" (basic). Default: "braille"}
+
+\item{border}{Draw border around plot. "auto" uses ggplot theme, or TRUE/FALSE (default: "auto")}
+
+\item{grid}{Grid lines: "none", "major", "minor", "both", or "auto" (default: "none")}
+
+\item{show_axes}{Whether to show axis values (default: TRUE)}
+
+\item{axis_labels}{Whether to show axis labels from ggplot (default: TRUE)}
+
+\item{legend}{Legend display: "auto", "right", "bottom", "none" (default: "auto")}
+
+\item{title_align}{Title alignment: "center" or "left" (default: "center")}
+
+\item{subtitle}{Whether to show subtitle (default: TRUE)}
+
+\item{caption}{Whether to show caption (default: TRUE)}
+
+\item{title}{Optional title override (NULL uses ggplot title)}
+
+\item{boxplot_style}{Style for boxplots: "ascii" uses box-drawing characters (default), 
+"braille" uses Braille dots like other geoms}
+}
+\value{
+Invisibly returns the canvas object
+}
+\description{
+Convert any ggplot2 plot to a terminal-based visualization using Unicode 
+Braille characters or ASCII. Supports 15+ geom types, faceting, themes,
+and color aesthetics.
+}
+\examples{
+library(ggplot2)
+
+# Basic scatter plot
+p <- ggplot(mtcars, aes(x = wt, y = mpg)) + geom_point()
+ggplotcli(p)
+
+# With styling
+ggplotcli(p, border = TRUE, grid = "major")
+
+# Faceted plot
+p <- ggplot(mtcars, aes(x = wt, y = mpg)) + 
+  geom_point() + 
+  facet_wrap(~cyl)
+ggplotcli(p, width = 70, height = 16)
+
+# Multiple geoms
+p <- ggplot(mtcars, aes(x = mpg)) +
+  geom_histogram(aes(y = after_stat(density)), bins = 10) +
+  geom_density(color = "red")
+ggplotcli(p)
+}

plotcli-original/man/init_color_mapping.Rd

@@ -0,0 +1,15 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{init_color_mapping}
+\alias{init_color_mapping}
+\title{Initialize color mapping for a set of ggplot colors}
+\usage{
+init_color_mapping(ggplot_colors)
+}
+\arguments{
+\item{ggplot_colors}{Vector of unique colors from ggplot}
+}
+\description{
+This function takes all unique colors from a ggplot and assigns terminal
+colors to minimize repetition while respecting hue similarity.
+}

plotcli-original/man/is_braille.Rd

@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper_functions.r
+\name{is_braille}
+\alias{is_braille}
+\title{Check if a character is a Braille character}
+\usage{
+is_braille(char)
+}
+\arguments{
+\item{char}{The character to be checked.}
+}
+\value{
+A boolean value indicating whether the character is a Braille character or not.
+}
+\description{
+This function checks if a given character is a Braille character.
+}
+\examples{
+is_braille("A")
+}