Start new project

library(project.aid)

Creating and starting a new project

This is very much started as a personal reference check-list when starting new R-projects.

Much of it is based on work from ROSTOOLS, but I have added a few personal preferences.

• Creating a new project in RStudio (check “create git” and “use renv”)

• Run the following:

renv::install("usethis")

usethis::use_package("pak", "Suggest")

• After pak is installed, edit the Rprofile file:

usethis::edit_r_profile(scope = "project")

Copy the following to the profile-file:

options(
  renv.settings.snapshot.type = "explicit",
  renv.config.auto.snapshot = TRUE,
  renv.config.pak.enabled = TRUE
)
source("renv/activate.R")

if (interactive()) {
  suppressMessages(require(usethis))
}

• To set up documentation, run this:

usethis::use_readme_md()

# License (one of the following or some different)
usethis::use_gpl3_license()
# or
usethis::use_ccby_license()

usethis::use_spell_check()

• Get the project to GitHub and start using GitHub Actions:

usethis::use_git()

usethis::use_github()

usethis::use_github_action()

• If using renv and Github Actions, then make sure to add - uses: r-lib/actions/setup-renv@v2 to the action .yaml files.

• Document development suing NEWS.md:

usethis::use_news_md()

Publishing the project

• Run in terminal:

quarto publish gh-pages

This will create a new `gh-pages` branches in the repository.

• Then run in console:

edit_file(".github/workflows/build-website.yaml")

 And then copy/paste this content to that file:

on:
  push:
    branches:
      - main
      - master
  workflow_dispatch:

name: Render and Publish

permissions:
  contents: write
  pages: write

jobs:
  build-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Set up Quarto
        uses: quarto-dev/quarto-actions/setup@v2
        with:
          # To install LaTeX to build PDF book
          tinytex: true
          # uncomment below and fill to pin a version
          # version: 0.9.600

       # The next two steps are used to setup the project when renv is used. Just uncomment and away you go!
#      - uses: r-lib/actions/setup-r@v2

#      - uses: r-lib/actions/setup-renv@v2

      # From https://github.com/r-lib/actions/tree/v2-branch/setup-r
      - name: Publish to GitHub Pages (and render)
        uses: quarto-dev/quarto-actions/publish@v2
        with:
          target: gh-pages
        env:
          # this secret is always available for github actions
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}