FreesearchR/man/import-globalenv.Rd

50 lines
1.5 KiB
R

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/import_globalenv-ext.R
\name{import-globalenv}
\alias{import-globalenv}
\alias{import_globalenv_ui}
\alias{import_globalenv_server}
\title{Import data from an Environment}
\usage{
import_globalenv_ui(
id,
globalenv = TRUE,
packages = datamods::get_data_packages(),
title = TRUE
)
import_globalenv_server(
id,
btn_show_data = TRUE,
show_data_in = c("popup", "modal"),
trigger_return = c("button", "change"),
return_class = c("data.frame", "data.table", "tbl_df", "raw"),
reset = reactive(NULL)
)
}
\arguments{
\item{id}{Module's ID.}
\item{globalenv}{Search for data in Global environment.}
\item{packages}{Name of packages in which to search data.}
\item{title}{Module's title, if \code{TRUE} use the default title,
use \code{NULL} for no title or a \code{shiny.tag} for a custom one.}
\item{btn_show_data}{Display or not a button to display data in a modal window if import is successful.}
\item{show_data_in}{Where to display data: in a \code{"popup"} or in a \code{"modal"} window.}
\item{trigger_return}{When to update selected data:
\code{"button"} (when user click on button) or
\code{"change"} (each time user select a dataset in the list).}
\item{return_class}{Class of returned data: \code{data.frame}, \code{data.table}, \code{tbl_df} (tibble) or \code{raw}.}
\item{reset}{A \code{reactive} function that when triggered resets the data.}
}
\description{
Let the user select a dataset from its own environment or from a package's environment.
Modified from datamods
}