This repository is an example repo to test out the holepunch
package. It uses a few tidyverse
packages but also the dataRetrieval
package for the yahara_dat
dataset.
To test holepunch
, follow these steps:
- Click Use this template to the left of Clone or download.
- Give this repo a new name and create a new repo in your account
- Click the Clone or download button, copy the URL.
- 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
- Install
holepunch
withremotes::install_github("karthik/holepunch")
- Then run the following code:
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 🙌
# If you're new to Git/GitHub, you can click the Git tab on Rstudio, then click commit to see
# all changed files/folders, including the hidden .binder folder. Give this a commmit message and push
# 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.