Scaffold a profile README.Rmd

Drops a starter README.Rmd into the target directory, pre-wired to call who_am_i() and gh_badges() (with commented-out chunks for who_am_i_gif() and so_rep()). Knit it to regenerate README.md for your GitHub profile repo.

Usage

use_profile_readme(
  name = "Your Name",
  likes = "your interests",
  learn = "what you're learning",
  work = "what you're working on",
  collab = "what you'd like to collaborate on",
  username = "your-github-username",
  path = ".",
  overwrite = FALSE,
  open = interactive()
)

Arguments

name, likes, learn, work, collab

Values substituted into the who_am_i() call. Each defaults to an editable placeholder.

username

GitHub username substituted into the gh_badges() call.

path

Directory to write README.Rmd into. Defaults to the current working directory.

overwrite

Logical; replace an existing README.Rmd?

open

Logical; open the new file in the editor when interactive.

Value

Invisibly returns the path to the written file.

Examples

if (FALSE) { # \dontrun{
use_profile_readme(
  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.",
  username = "mjfrigaard"
)
} # }