Skip to contents

ghreadme

The goal of ghreadme is to create your GitHub profile README.md using R Markdown.

Installation

You can install the development version of ghreadme like so:

remotes::install_github("mjfrigaard/ghreadme")

Example

Load the package, create a repo with the same name as your username (i.e., https://github.com/<username>/<username>), then add the following to your README.Rmd file (set echo=FALSE to hide the code).

who_am_i(name = "Martin",
  likes = "#rstats and data visualization.",
  learn = "Shiny app development, Python, and Linux",
  work = "R package development tools.",
  collab = "#rstats packages for data science."
  )
     👋 Hi, my name is Martin.

     👀 I like #rstats and data visualization.

     🌱 I'm learning about Shiny app development, Python, and Linux

     📦 I'm currently working on R package development tools.

     💞 I'd love to collaborate on #rstats packages for data science.

     📫 Want to connect? Use the badges below...

GitHub badges

For GitHub badges from vercel.app, include the call in a code chunk with results set to asis.

Example:

```{r gh_badges, results='asis'}
gh_badges(username = "mjfrigaard", 
  badge = c("details", "stats", "repo_lang"), 
  theme = "dark")
```

Stack Overflow reputation

Example:

```{r so_rep, results='asis'}
so_rep(
  username = "martin-frigaard", 
  user_id = "4926446")
```

StackOverflow