https://github.com/ColinFay/fryingpane
Serve datasets from a package inside the RStudio Connection Pane.
https://github.com/ColinFay/fryingpane
Last synced: 4 months ago
JSON representation
Serve datasets from a package inside the RStudio Connection Pane.
- Host: GitHub
- URL: https://github.com/ColinFay/fryingpane
- Owner: ColinFay
- License: other
- Created: 2018-05-15T12:10:51.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-17T15:27:54.000Z (almost 7 years ago)
- Last Synced: 2024-08-13T07:15:35.220Z (8 months ago)
- Language: R
- Homepage:
- Size: 22.3 MB
- Stars: 42
- Watchers: 7
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - ColinFay/fryingpane - Serve datasets from a package inside the RStudio Connection Pane. (R)
README
---
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
[](https://www.tidyverse.org/lifecycle/#experimental)
# fryingpane
Serve the datasets from a package inside the RStudio Connection Pane.
## Installation
You can install the dev version of {fryingpane} from [Github](https://github.com/ColinFay/fryingpane) with:
```{r eval = FALSE}
# install.packages("remotes")
remotes::install_github("ColinFay/fryingpane")
```
## What is this about?
### In your package
Use this package to create a function for displaying your package data inside the RStudio Connection Pane.
Note that `{fryingpane}` should be listed as a dependency to your new package.
#### Function to launch connection
Create a function that launch the connection pane with the datasets from your package. This function should have this form in the `.R` (change `mypkg` to the name of your package):
```{r eval = FALSE}
#' Launch Connection Pane
#' @export
#' @importFrom fryingpane serve
#' @example
open_connection <- fryingpane::serve("mypkg")
```
### View the data from another package
You can open the datasets from another package.
```{r eval = FALSE}
library(fryingpane)
cook("dplyr")
```
Close the connection with the ad hoc button.
You can find an history of your last connection in the Connections pane.
## Demo
## Contact
Questions and feedbacks [welcome](mailto:[email protected])!
You want to contribute ? Open a [PR](https://github.com/ColinFay/fryingpane/pulls) :) If you encounter a bug or want to suggest an enhancement, please [open an issue](https://github.com/ColinFay/fryingpane/issues).
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.