plotcli-py 0.1.0__py3-none-any.whl

plotcli-original/man/is_geom_registered.Rd

@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{is_geom_registered}
+\alias{is_geom_registered}
+\title{Check if a Geom is Registered}
+\usage{
+is_geom_registered(geom_name)
+}
+\arguments{
+\item{geom_name}{Name of the geom}
+}
+\value{
+Logical
+}
+\description{
+Check if a Geom is Registered
+}

plotcli-original/man/list_registered_geoms.Rd

@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/geom_registry.r
+\name{list_registered_geoms}
+\alias{list_registered_geoms}
+\title{List Registered Geoms}
+\usage{
+list_registered_geoms()
+}
+\value{
+Character vector of registered geom names
+}
+\description{
+List Registered Geoms
+}

plotcli-original/man/make_colored.Rd

@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper_functions.r
+\name{make_colored}
+\alias{make_colored}
+\title{Make colored text}
+\usage{
+make_colored(x, color = NULL)
+}
+\arguments{
+\item{x}{The text string to be colored.}
+
+\item{color}{The color to be applied to the text. If NULL, the color codes will be removed.}
+}
+\value{
+A colored text string or a text string with color codes removed.
+}
+\description{
+This function applies a specified color to a given text string.
+}
+\examples{
+make_colored("Hello, world!", "blue")
+make_colored("Hello, world!", NULL)
+}

plotcli-original/man/make_unique_names.Rd

@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper_functions.r
+\name{make_unique_names}
+\alias{make_unique_names}
+\title{Make unique names}
+\usage{
+make_unique_names(names)
+}
+\arguments{
+\item{names}{A character vector of names.}
+}
+\value{
+A character vector of unique names.
+}
+\description{
+This function takes a vector of names and ensures that each name is unique by appending a number if necessary.
+}
+\examples{
+make_unique_names(c("apple", "apple", "banana", "apple"))
+}

plotcli-original/man/normalize_data.Rd

@@ -0,0 +1,27 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper_functions.r
+\name{normalize_data}
+\alias{normalize_data}
+\title{Normalize data}
+\usage{
+normalize_data(data, data_min, data_max, plot_range)
+}
+\arguments{
+\item{data}{The data to be normalized.}
+
+\item{data_min}{The minimum value of the data.}
+
+\item{data_max}{The maximum value of the data.}
+
+\item{plot_range}{The range to normalize the data to.}
+}
+\value{
+The normalized data.
+}
+\description{
+This function normalizes the given data to a specified plot range.
+}
+\examples{
+normalize_data(c(1, 2, 3, 4, 5), 1, 5, 10)
+normalize_data(c(10, 20, 30, 40, 50), 10, 50, 100)
+}

plotcli-original/man/pclib.Rd

@@ -0,0 +1,48 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{pclib}
+\alias{pclib}
+\title{Short version of plotcli_bar}
+\usage{
+pclib(
+  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",
+  ...
+)
+}
+\arguments{
+\item{y}{A numeric vector of values}
+
+\item{x}{A vector of categories}
+
+\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: "barplot")}
+
+\item{...}{Additional arguments passed to the plotcli$new() function}
+}
+\description{
+Short version of plotcli_bar function.
+}
+\examples{
+x <- 1:5
+y <- c(10, 15, 8, 12, 6)
+pclib(x, y)
+}

plotcli-original/man/pclibx.Rd

@@ -0,0 +1,46 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{pclibx}
+\alias{pclibx}
+\title{Short version of plotcli_box}
+\usage{
+pclibx(
+  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",
+  ...
+)
+}
+\arguments{
+\item{y}{A list of numeric vectors 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: "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: "boxplot")}
+
+\item{...}{Additional arguments passed to the plotcli$new() function}
+
+\item{x}{A vector of categories}
+}
+\description{
+Short version of plotcli_box function.
+}
+\examples{
+y <- rnorm(50, mean = 0)
+pclib(y)
+}

plotcli-original/man/pclid.Rd

@@ -0,0 +1,44 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{pclid}
+\alias{pclid}
+\title{Short version of plotcli_density}
+\usage{
+pclid(
+  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{
+Short version of plotcli_density function.
+}
+\examples{
+x <- rnorm(100)
+pclid(x)
+}

plotcli-original/man/pclih.Rd

@@ -0,0 +1,50 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{pclih}
+\alias{pclih}
+\title{Short version of plotcli_histogram}
+\usage{
+pclih(
+  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{
+Short version of plotcli_histogram function.
+}
+\examples{
+x <- rnorm(100)
+pclih(x)
+}

plotcli-original/man/pclil.Rd

@@ -0,0 +1,48 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{pclil}
+\alias{pclil}
+\title{Short version of plotcli_line}
+\usage{
+pclil(
+  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{
+Short version of plotcli_line function.
+}
+\examples{
+x <- 1:10
+y <- x^2
+pclil(x, y)
+}

plotcli-original/man/pclis.Rd

@@ -0,0 +1,48 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/plotcli_wrappers.r
+\name{pclis}
+\alias{pclis}
+\title{Short version of plotcli_scatter}
+\usage{
+pclis(
+  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{
+Short version of plotcli_scatter function.
+}
+\examples{
+x <- rnorm(100)
+y <- rnorm(100)
+pclis(x, y)
+}

plotcli-original/man/pixel_to_braille.Rd

@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper_functions.r
+\name{pixel_to_braille}
+\alias{pixel_to_braille}
+\title{Convert pixel coordinates to Braille cell and dot position}
+\usage{
+pixel_to_braille(px, py, canvas_rows, canvas_cols)
+}
+\arguments{
+\item{px}{Pixel x coordinate (1-based)}
+
+\item{py}{Pixel y coordinate (1-based, from top)}
+
+\item{canvas_rows}{Number of character rows in canvas}
+
+\item{canvas_cols}{Number of character columns in canvas}
+}
+\value{
+List with cell_row, cell_col, dot_row, dot_col
+}
+\description{
+Convert pixel coordinates to Braille cell and dot position
+}