plotcli-py 0.1.0__py3-none-any.whl

plotcli-original/R/plotcli_grid.r

@@ -0,0 +1 @@
+# to be built

plotcli-original/R/plotcli_wrappers.r

@@ -0,0 +1,416 @@
+#' @title Scatter plot using plotcli
+#' @description Create a scatter plot using plotcli. Short alias: \code{pclis}.
+#' @param x A numeric vector of x values
+#' @param y A numeric vector of y values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "y")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "scatter")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#' 
+#' @examples
+#' x <- rnorm(100)
+#' y <- rnorm(100)
+#' plotcli_scatter(x, y)
+plotcli_scatter <- function(
+                            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",
+                            ...
+                            ) {
+
+  if(is.null(y)) stop("Please provide x and/or y values.")
+  if(is.null(x)) x <- 1:length(y)
+
+  plot <- plotcli$new(
+                      plot_width = plot_width, 
+                      plot_height = plot_height, 
+                      x_label = x_label,
+                      y_label = y_label, 
+                      draw_legend = FALSE,
+                      ...
+                      )
+
+  data <- list(x = x, y = y, type = "scatter", color = color, braille = braille, name = name)
+  plot$add_data(data)
+  return(plot)
+
+}
+
+#' @title Density plot using plotcli
+#' @description Create a density plot using plotcli. Short alias: \code{pcld}.
+#' @param x A numeric vector of values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "Density")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "density")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' x <- rnorm(100)
+#' plotcli_density(x)
+plotcli_density <- function(
+                            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",
+                            ...
+                            ) {
+
+  y <- stats::density(x)$y
+  x <- stats::density(x)$x
+
+  plot <- plotcli$new(
+                      plot_width = plot_width,
+                      plot_height = plot_height,
+                      x_label = x_label,
+                      y_label = y_label,
+                      draw_legend = FALSE,
+                      ...
+                      )
+
+  data <- list(x = x, y = y, type = "line", color = color, braille = braille, name = name)
+  plot$add_data(data)
+  return(plot)
+
+}
+
+#' @title Line plot using plotcli
+#' @description Create a line plot using plotcli. Short alias: \code{pcli}.
+#' @param x A numeric vector of x values
+#' @param y A numeric vector of y values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "y")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "line")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' x <- 1:10
+#' y <- x^2
+#' plotcli_line(x, y)
+plotcli_line <- function(
+                         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",
+                         ...
+                         ) {
+
+  if(is.null(y)) stop("Please provide x and/or y values.")
+  if(is.null(x)) x <- 1:length(y)
+
+  plot <- plotcli$new(
+                      plot_width = plot_width,
+                      plot_height = plot_height,
+                      x_label = x_label,
+                      y_label = y_label,
+                      draw_legend = FALSE,
+                      ...
+                      )
+
+  data <- list(x = x, y = y, type = "line", color = color, braille = braille, name = name)
+  plot$add_data(data)
+  return(plot)
+
+}
+
+#' @title Histogram plot using plotcli
+#' @description Create a histogram plot using plotcli. Short alias: \code{pclih}.
+#' @param x A numeric vector of values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "Frequency")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param bin_width Width of the bins (default: NULL)
+#' @param ylim y limits (default: NULL)
+#' @param name Name of the plot element (default: "histogram")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' x <- rnorm(100)
+#' plotcli_histogram(x)
+plotcli_histogram <- function(
+                              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",
+                              ...
+                              ) {
+
+  hist_data <- graphics::hist(
+                    x, 
+                    plot = FALSE, 
+                    breaks = if (!is.null(bin_width)) seq(min(x), max(x) + bin_width, by = bin_width) else "Sturges"
+                    )
+
+  y <- hist_data$counts
+  x <- hist_data$mids
+
+  if(is.null(ylim)) ylim <- c(0, max(y) * 1.05)
+
+  plot <- plotcli$new(
+                      plot_width = plot_width,
+                      plot_height = plot_height,
+                      x_label = x_label,
+                      y_label = y_label,
+                      draw_legend = FALSE,
+                      ylim = ylim,
+                      ...
+                      )
+
+  data <- list(x = x, y = y, type = "barplot", color = color, braille = braille, name = name)
+  plot$add_data(data)
+  return(plot)
+
+}
+
+#' @title Bar plot using plotcli
+#' @description Create a bar plot using plotcli. Short alias: \code{pclb}.
+#' @param x A vector of categories
+#' @param y A numeric vector of values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "y")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "barplot")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' x <- 1:5
+#' y <- c(10, 15, 8, 12, 6)
+#' plotcli_bar(x, y)
+plotcli_bar <- function(
+                        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 = "barplot",
+                        ...
+                        ) {
+
+  if(is.null(y)) stop("Please provide x and/or y values.")
+  if(is.null(x)) x <- 1:length(y)
+
+  plot <- plotcli$new(
+                      plot_width = plot_width,
+                      plot_height = plot_height,
+                      x_label = x_label,
+                      y_label = y_label,
+                      draw_legend = FALSE,
+                      ...
+                      )
+
+
+  data <- list(x = x, y = y, type = "barplot", color = color, braille = braille, name = name)
+  plot$add_data(data)
+  return(plot)
+
+}
+
+#' @title Box plot using plotcli
+#' @description Create a box plot using plotcli. Short alias: \code{pclbx}.
+#' @param x A vector of categories
+#' @param y A list of numeric vectors of values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "y")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "boxplot")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' y <- rnorm(50, mean = 0)
+#' plotcli_box(y)
+plotcli_box <- function(
+                     y, 
+                     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 = "boxplot",
+                     ...
+                     ) {
+
+  plot <- plotcli$new(
+                      plot_width = plot_width,
+                      plot_height = plot_height,
+                      x_label = x_label,
+                      y_label = y_label,
+                      draw_legend = FALSE,
+                      ...
+                      )
+
+  x = rep(1, length(y))
+  data <- list(x = x, y = y, type = "boxplot", color = color, braille = braille, name = name)
+  plot$add_data(data)
+  return(plot)
+
+}
+
+# short versions
+
+#' @title Short version of plotcli_scatter
+#' @description Short version of plotcli_scatter function.
+#' @param x A numeric vector of x values
+#' @param y A numeric vector of y values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "y")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "scatter")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#' 
+#' @examples
+#' x <- rnorm(100)
+#' y <- rnorm(100)
+#' pclis(x, y)
+pclis <- plotcli_scatter
+
+#' @title Short version of plotcli_density
+#' @description Short version of plotcli_density function.
+#' @param x A numeric vector of values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "Density")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "density")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' x <- rnorm(100)
+#' pclid(x)
+pclid <- plotcli_density
+
+#' @title Short version of plotcli_line
+#' @description Short version of plotcli_line function.
+#' @param x A numeric vector of x values
+#' @param y A numeric vector of y values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "y")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "line")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' x <- 1:10
+#' y <- x^2
+#' pclil(x, y)
+pclil <- plotcli_line
+
+#' @title Short version of plotcli_histogram
+#' @description Short version of plotcli_histogram function.
+#' @param x A numeric vector of values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "Frequency")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param bin_width Width of the bins (default: NULL)
+#' @param ylim y limits (default: NULL)
+#' @param name Name of the plot element (default: "histogram")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' x <- rnorm(100)
+#' pclih(x)
+pclih <- plotcli_histogram
+
+#' @title Short version of plotcli_bar
+#' @description Short version of plotcli_bar function.
+#' @param x A vector of categories
+#' @param y A numeric vector of values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "y")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "barplot")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' x <- 1:5
+#' y <- c(10, 15, 8, 12, 6)
+#' pclib(x, y)
+pclib <- plotcli_bar
+
+#' @title Short version of plotcli_box
+#' @description Short version of plotcli_box function.
+#' @param x A vector of categories
+#' @param y A list of numeric vectors of values
+#' @param plot_width Width of the plot (default: 80)
+#' @param plot_height Height of the plot (default: 40)
+#' @param x_label Label for the x-axis (default: "x")
+#' @param y_label Label for the y-axis (default: "y")
+#' @param color Color of the plot elements (default: NULL)
+#' @param braille Use Braille characters for the plot (default: TRUE)
+#' @param name Name of the plot element (default: "boxplot")
+#' @param ... Additional arguments passed to the plotcli$new() function
+#' @export
+#'
+#' @examples
+#' y <- rnorm(50, mean = 0)
+#' pclib(y)
+pclibx <- plotcli_box

plotcli-original/R/zzz.r

@@ -0,0 +1,15 @@
+.onLoad <- function(libname, pkgname) {
+  # Enable crayon colors even in non-interactive sessions (e.g., Rscript)
+  # This ensures colored output works when running scripts
+  if (is.null(getOption("crayon.enabled"))) {
+    options(crayon.enabled = TRUE)
+  }
+}
+
+.onAttach <- function(libname, pkgname) {
+  # Set default options
+  plotcli_options(plot_width = 60, plot_height = 20, braille = FALSE)
+
+  # Display a startup message
+  packageStartupMessage("plotcli loaded. Use plotcli_options() to set global options.")
+}

plotcli-original/README.md

@@ -0,0 +1,192 @@
+# plotcli: ggplot2 in Your Terminal
+
+[![CRAN status](https://www.r-pkg.org/badges/version/plotcli?color=green)](https://CRAN.R-project.org/package=plotcli)
+[![CRAN checks](https://badges.cranchecks.info/worst/plotcli.svg)](https://cran.r-project.org/web/checks/check_results_plotcli.html)
+[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/plotcli)](https://www.r-pkg.org/pkg/plotcli)
+[![Downloads](https://cranlogs.r-pkg.org/badges/plotcli?color=blue)](https://www.r-pkg.org/pkg/plotcli)
+
+<p align="center">
+  <img src="docs/scatter.png" alt="plotcli: colored scatter plot in terminal" width="700">
+</p>
+
+plotcli renders ggplot2 plots directly in the terminal using Unicode Braille characters and ANSI colors.
+Write your ggplot code as usual, then call `ggplotcli()` to see it in the console -- no graphics device needed.
+
+Inspired by the excellent [UnicodePlots.jl](https://github.com/JuliaPlots/UnicodePlots.jl).
+
+## Installation
+
+```r
+# From CRAN
+install.packages("plotcli")
+
+# Development version from GitHub
+remotes::install_github("cheuerde/plotcli")
+```
+
+## Quick Start
+
+Any ggplot2 plot works. Build your plot as usual, then pass it to `ggplotcli()`:
+
+```r
+library(plotcli)
+library(ggplot2)
+
+p <- ggplot(mtcars, aes(x = wt, y = mpg, color = factor(cyl))) +
+  geom_point() +
+  labs(title = "MPG vs Weight by Cylinders",
+       x = "Weight (1000 lbs)", y = "Miles per Gallon",
+       color = "Cylinders") +
+  theme_bw()
+
+ggplotcli(p)
+```
+
+<p align="center">
+  <img src="docs/scatter.png" alt="Scatter plot with colored groups" width="700">
+</p>
+
+## Gallery
+
+### Boxplots
+
+```r
+p <- ggplot(df, aes(x = group, y = value, fill = group)) +
+  geom_boxplot() +
+  labs(title = "Distribution Comparison by Group")
+ggplotcli(p)
+```
+
+<p align="center">
+  <img src="docs/boxplot.png" alt="Boxplot" width="700">
+</p>
+
+### Line Charts
+
+```r
+p <- ggplot(economics, aes(x = date, y = unemploy)) +
+  geom_line(color = "steelblue") +
+  geom_smooth(color = "red", se = FALSE) +
+  labs(title = "US Unemployment Over Time")
+ggplotcli(p)
+```
+
+<p align="center">
+  <img src="docs/line.png" alt="Line chart" width="700">
+</p>
+
+### Bar Charts
+
+<p align="center">
+  <img src="docs/bar.png" alt="Bar chart" width="700">
+</p>
+
+### Histograms
+
+<p align="center">
+  <img src="docs/histogram.png" alt="Histogram" width="700">
+</p>
+
+### Density Plots
+
+<p align="center">
+  <img src="docs/density.png" alt="Density plot" width="700">
+</p>
+
+### Heatmaps
+
+```r
+cor_mat <- cor(mtcars[, c("mpg", "cyl", "disp", "hp", "wt", "qsec")])
+df <- as.data.frame(as.table(cor_mat))
+names(df) <- c("Var1", "Var2", "value")
+p <- ggplot(df, aes(Var1, Var2, fill = value)) +
+  geom_tile() +
+  labs(title = "Correlation Heatmap", fill = "correlation")
+ggplotcli(p)
+```
+
+<p align="center">
+  <img src="docs/heatmap.png" alt="Heatmap" width="700">
+</p>
+
+### Faceted Plots
+
+```r
+p <- ggplot(mpg, aes(x = displ, y = hwy)) +
+  geom_point(color = "steelblue") +
+  geom_smooth(method = "lm", color = "red", se = FALSE) +
+  facet_wrap(~drv) +
+  theme_bw()
+ggplotcli(p, width = 80, height = 18)
+```
+
+<p align="center">
+  <img src="docs/facet.png" alt="Faceted plot" width="700">
+</p>
+
+### Canvas Types
+
+**Block canvas** -- medium resolution using block characters:
+<p align="center">
+  <img src="docs/block.png" alt="Block canvas" width="600">
+</p>
+
+**ASCII canvas** -- basic ASCII for maximum compatibility:
+<p align="center">
+  <img src="docs/ascii.png" alt="ASCII canvas" width="600">
+</p>
+
+## Supported Geoms (27)
+
+| Geom | Status |
+|------|--------|
+| `geom_point` | :white_check_mark: |
+| `geom_line`, `geom_path` | :white_check_mark: |
+| `geom_step` | :white_check_mark: |
+| `geom_bar`, `geom_col`, `geom_histogram` | :white_check_mark: |
+| `geom_boxplot` | :white_check_mark: |
+| `geom_violin` | :white_check_mark: |
+| `geom_density` | :white_check_mark: |
+| `geom_smooth` | :white_check_mark: |
+| `geom_area` | :white_check_mark: |
+| `geom_ribbon` | :white_check_mark: |
+| `geom_segment`, `geom_hline`, `geom_vline`, `geom_abline` | :white_check_mark: |
+| `geom_errorbar`, `geom_linerange`, `geom_pointrange`, `geom_crossbar` | :white_check_mark: |
+| `geom_rect`, `geom_tile`, `geom_raster` (heatmaps) | :white_check_mark: |
+| `geom_text`, `geom_label` | :white_check_mark: |
+| `geom_rug` | :white_check_mark: |
+| `facet_wrap`, `facet_grid` | :white_check_mark: |
+
+## Options
+
+```r
+# Control size
+ggplotcli(p, width = 80, height = 24)
+
+# Canvas types
+ggplotcli(p, canvas_type = "braille")  # High resolution (default)
+ggplotcli(p, canvas_type = "block")    # Block characters
+ggplotcli(p, canvas_type = "ascii")    # ASCII only
+```
+
+## Direct R6 Class Usage
+
+For lower-level control, use the `plotcli` R6 class directly:
+
+```r
+pc <- plotcli$new(plot_width = 60, plot_height = 20, x_label = "wt", y_label = "mpg",
+                  title = "MPG vs Weight")
+pc$add_data(list(x = mtcars$wt, y = mtcars$mpg, type = "scatter", name = "mtcars"))
+pc$print_plot()
+```
+
+## Similar Projects
+
+- [txtplot](https://github.com/bbnkmp/txtplot/): The OG in R
+- [r-plot](https://github.com/geotheory/r-plot): Collection of excellent terminal plotting functions
+- [UnicodePlots.jl](https://github.com/JuliaPlots/UnicodePlots.jl): The gold standard for terminal graphics
+- [plotext](https://github.com/piccolomo/plotext): Powerful terminal graphics in Python
+
+## License
+
+`plotcli` is released under the LGPL-3 License.