@damurka/jovian 0.1.0

package/packages/hera/man/CommManager.Rd

@@ -0,0 +1,215 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/comm.R
+\name{CommManagerClass}
+\alias{CommManagerClass}
+\alias{CommManager}
+\title{Comm Manager class}
+\usage{
+CommManager
+}
+\description{
+Instance of the \link{CommManagerClass} class.
+}
+\section{Methods}{
+\subsection{Public methods}{
+  \itemize{
+    \item \href{#method-CommManagerClass-initialize}{\code{CommManagerClass$new()}}
+    \item \href{#method-CommManagerClass-register_comm_target}{\code{CommManagerClass$register_comm_target()}}
+    \item \href{#method-CommManagerClass-unregister_comm_target}{\code{CommManagerClass$unregister_comm_target()}}
+    \item \href{#method-CommManagerClass-new_comm}{\code{CommManagerClass$new_comm()}}
+    \item \href{#method-CommManagerClass-comms}{\code{CommManagerClass$comms()}}
+    \item \href{#method-CommManagerClass-target_callback}{\code{CommManagerClass$target_callback()}}
+    \item \href{#method-CommManagerClass-preserve}{\code{CommManagerClass$preserve()}}
+    \item \href{#method-CommManagerClass-release}{\code{CommManagerClass$release()}}
+    \item \href{#method-CommManagerClass-get_comm_info}{\code{CommManagerClass$get_comm_info()}}
+    \item \href{#method-CommManagerClass-clone}{\code{CommManagerClass$clone()}}
+  }
+}
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-initialize"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-initialize}{}}}
+\subsection{\code{CommManagerClass$new()}}{
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$new(..., error_call = caller_env())}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Arguments}{
+    \if{html}{\out{<div class="arguments">}}
+    \describe{
+      \item{\code{...}}{currently unused}
+      \item{\code{error_call}}{see \code{\link[rlang:args_error_context]{rlang::args_error_context()}}}
+    }
+    \if{html}{\out{</div>}}
+  }
+}
+
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-register_comm_target"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-register_comm_target}{}}}
+\subsection{\code{CommManagerClass$register_comm_target()}}{
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$register_comm_target(
+  target_name,
+  callback = function(comm, message) {
+ }
+)}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Arguments}{
+    \if{html}{\out{<div class="arguments">}}
+    \describe{
+      \item{\code{target_name}}{name of the comm target, e.g. "jupyter.widgets"}
+      \item{\code{callback}}{callback function taking two arguments 'comm' and 'message'.}
+    }
+    \if{html}{\out{</div>}}
+  }
+}
+
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-unregister_comm_target"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-unregister_comm_target}{}}}
+\subsection{\code{CommManagerClass$unregister_comm_target()}}{
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$unregister_comm_target(target_name)}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Arguments}{
+    \if{html}{\out{<div class="arguments">}}
+    \describe{
+      \item{\code{target_name}}{name of the comm target}
+    }
+    \if{html}{\out{</div>}}
+  }
+}
+
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-new_comm"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-new_comm}{}}}
+\subsection{\code{CommManagerClass$new_comm()}}{
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$new_comm(target_name, description = "")}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Arguments}{
+    \if{html}{\out{<div class="arguments">}}
+    \describe{
+      \item{\code{target_name}}{name of the target}
+      \item{\code{description}}{description of the comm}
+    }
+    \if{html}{\out{</div>}}
+  }
+}
+
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-comms"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-comms}{}}}
+\subsection{\code{CommManagerClass$comms()}}{
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$comms()}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Returns}{
+    the list of currently open comms
+  }
+}
+
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-target_callback"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-target_callback}{}}}
+\subsection{\code{CommManagerClass$target_callback()}}{
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$target_callback(target_name)}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Arguments}{
+    \if{html}{\out{<div class="arguments">}}
+    \describe{
+      \item{\code{target_name}}{name of the comm target}
+    }
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Returns}{
+    the callback for that target name
+  }
+}
+
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-preserve"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-preserve}{}}}
+\subsection{\code{CommManagerClass$preserve()}}{
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$preserve(comm)}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Arguments}{
+    \if{html}{\out{<div class="arguments">}}
+    \describe{
+      \item{\code{comm}}{\link{Comm} instance to preserve}
+    }
+    \if{html}{\out{</div>}}
+  }
+}
+
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-release"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-release}{}}}
+\subsection{\code{CommManagerClass$release()}}{
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$release(comm)}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Arguments}{
+    \if{html}{\out{<div class="arguments">}}
+    \describe{
+      \item{\code{comm}}{\link{Comm} instance to release}
+    }
+    \if{html}{\out{</div>}}
+  }
+}
+
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-get_comm_info"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-get_comm_info}{}}}
+\subsection{\code{CommManagerClass$get_comm_info()}}{
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$get_comm_info(target_name = NULL)}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Arguments}{
+    \if{html}{\out{<div class="arguments">}}
+    \describe{
+      \item{\code{target_name}}{name of the target to get info about all comm opens. If NULL, info for comms for all targets are returned.}
+    }
+    \if{html}{\out{</div>}}
+  }
+}
+
+\if{html}{\out{<hr>}}
+\if{html}{\out{<a id="method-CommManagerClass-clone"></a>}}
+\if{latex}{\out{\hypertarget{method-CommManagerClass-clone}{}}}
+\subsection{\code{CommManagerClass$clone()}}{
+  The objects of this class are cloneable with this method.
+  \subsection{Usage}{
+    \if{html}{\out{<div class="r">}}
+    \preformatted{CommManagerClass$clone(deep = FALSE)}
+    \if{html}{\out{</div>}}
+  }
+  \subsection{Arguments}{
+    \if{html}{\out{<div class="arguments">}}
+    \describe{
+      \item{\code{deep}}{Whether to make a deep clone.}
+    }
+    \if{html}{\out{</div>}}
+  }
+}
+
+}

package/packages/hera/man/View.Rd

@@ -0,0 +1,22 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/routines.R
+\name{View}
+\alias{View}
+\title{View}
+\usage{
+View(x, title)
+}
+\arguments{
+\item{x}{something to display}
+
+\item{title}{title of the display}
+}
+\description{
+View
+}
+\examples{
+\dontrun{
+  View(mtcars)
+}
+
+}

package/packages/hera/man/cell_options.Rd

@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/cell_options.R
+\name{cell_options}
+\alias{cell_options}
+\title{Options for current jupyter cell}
+\usage{
+cell_options(...)
+}
+\arguments{
+\item{...}{options to set locally to the notebook cell. Forwarded to \code{\link[rlang:local_options]{rlang::local_options()}}.}
+}
+\description{
+Options for current jupyter cell
+}
+\examples{
+\dontrun{
+  cell_options(repr.plot.bg = "gray")
+}
+
+}

package/packages/hera/man/clear_output.Rd

@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/routines.R
+\name{clear_output}
+\alias{clear_output}
+\title{Clear output}
+\usage{
+clear_output(wait = FALSE)
+}
+\arguments{
+\item{wait}{Should this wait}
+}
+\value{
+NULL invisibly
+}
+\description{
+Clear output
+}
+\examples{
+\dontrun{
+  clear_output()
+}
+
+}

package/packages/hera/man/complete.Rd

@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/completion.R
+\name{complete}
+\alias{complete}
+\title{Code completion}
+\usage{
+complete(code, cursor_pos = nchar(code))
+}
+\arguments{
+\item{code}{R code to complete}
+
+\item{cursor_pos}{position of the cursor}
+}
+\value{
+a list that contains potential completions as the first item
+}
+\description{
+Code completion
+}
+\examples{
+complete("rnorm(")
+
+}

package/packages/hera/man/display_data.Rd

@@ -0,0 +1,22 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/routines.R
+\name{display_data}
+\alias{display_data}
+\title{Display data}
+\usage{
+display_data(data = NULL, metadata = NULL)
+}
+\arguments{
+\item{data}{data to display}
+
+\item{metadata}{potential metadata}
+}
+\description{
+Display data
+}
+\examples{
+\dontrun{
+  display_data(mtcars)
+}
+
+}

package/packages/hera/man/is_elara.Rd

@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/zzz.R
+\name{is_elara}
+\alias{is_elara}
+\title{Is this a running Elara jupyter kernel}
+\usage{
+is_elara()
+}
+\value{
+TRUE if the current session is running in an Elara kernel
+}
+\description{
+Is this a running Elara jupyter kernel
+}
+\examples{
+is_elara()
+
+}

package/packages/hera/man/mime_bundle.Rd

@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/mime_bundle.R
+\name{mime_bundle}
+\alias{mime_bundle}
+\title{bundle an object}
+\usage{
+mime_bundle(x, mimetypes = mime_types(x), ...)
+}
+\arguments{
+\item{x}{an object}
+
+\item{mimetypes}{mime types}
+
+\item{...}{extra currently unused parameters}
+}
+\description{
+bundle an object
+}
+\examples{
+mime_bundle(letters)
+
+}
+\seealso{
+IRdisplay::prepare_mimebundle which this currently wraps around
+}

package/packages/hera/man/mime_types.Rd

@@ -0,0 +1,22 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/mime_bundle.R
+\name{mime_types}
+\alias{mime_types}
+\title{MIME types supported by an object}
+\usage{
+mime_types(x)
+}
+\arguments{
+\item{x}{an object}
+}
+\value{
+a character vector of its supported mime types
+}
+\description{
+MIME types supported by an object
+}
+\examples{
+mime_types(letters)
+mime_types(mtcars)
+
+}

package/packages/hera/man/reexports.Rd

@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/zzz.R
+\docType{import}
+\name{reexports}
+\alias{reexports}
+\alias{display}
+\title{Objects exported from other packages}
+\keyword{internal}
+\description{
+These objects are imported from other packages. Follow the links
+below to see their documentation.
+
+\describe{
+  \item{IRdisplay}{\code{\link[IRdisplay:display]{display()}}}
+}}
+