https://github.com/tmorrell/holepunch-test
https://github.com/tmorrell/holepunch-test
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/tmorrell/holepunch-test
- Owner: tmorrell
- Created: 2019-07-30T17:04:29.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-30T17:04:30.000Z (almost 7 years ago)
- Last Synced: 2025-02-16T07:13:11.485Z (over 1 year ago)
- Language: R
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Example repo for testing `holepunch`
This repository is an example repo to test out the [`holepunch`](https://github.com/karthik/holepunch) package. It uses a few `tidyverse` packages but also the `dataRetrieval` package for the `yahara_dat` dataset.
To test `holepunch`, follow these steps:
1. Click Use this template to the left of Clone or download.
2. Give this repo a new name and create a new repo in your account
3. Click the Clone or download button, copy the URL.
4. in RStudio Desktop, click the Project drop down on the top right, Choose **New Project** > **Version Control** > **Git**, and paste in the URL of your new GitHub repository
# Now in RStudio
1. Install `holepunch` with `remotes::install_github("karthik/holepunch")`
2. Then run the following code:
```r
library(holepunch)
write_compendium_description(package = "Your compendium name",
description = "Your compendium description")
# to write a description, with dependencies listed
# It's good practice to now go fill in the placeholder text.
write_dockerfile(maintainer = "your_name")
# To write a dockerfile. It will automatically pick the date of the last modified file, match it to
# that version of R and add it here. You can override this by passing r_date to some arbitrary date
# (but one for which a R version exists).
generate_badge()
# This generates a badge for your readme.
# At this time 🙌 push the code to GitHub 🙌
# And click on the badge or use the function below to get the binder built ahead of time.
build_binder()
# 🤞🚀
Now, run through analysis.R till you get to a plot
```
Does clicking the badge launch binder for you? If not, please [file an issue](https://github.com/karthik/binder-test/issues/new).