Get Started

Authors: Brian Schilder, Alan Murphy, Nathan Skene

Vignette updated: Sep-21-2024

library(rworkflows)

GitHub Secrets

Before pushing changes to your new R package, you may want to set up one or more GitHub Secrets:

GITHUB_TOKEN [Optional]: Can grant access to private repos on GitHub Actions. You can generate your very own Personal Authentication Token using these instructions.
DOCKER_TOKEN [Optional]: Allows GitHub Actions to push to a DockerHub account.

`use_workflow`

dynamic action

User only have to run use_workflow once per R package to create a workflow file that calls the rworkflows action.

workflow <- rworkflows::use_workflow(run_bioccheck = FALSE, 
                                     run_rcmdcheck = TRUE,  
                                     run_pkgdown = TRUE, 
                                     run_docker = TRUE,
                                     docker_user = "bschilder",
                                     docker_org = "neurogenomicslab",
                                     force_new = TRUE,
                                     ## Use default save_dir in practice
                                     save_dir = tempdir())

## Saving yaml ==> /var/folders/rd/rbc_wrdj4k3djf3brk6z0_dc0000gp/T//RtmpHZJkFH/rworkflows.yml

static workflow

Alternatively, you may use

workflow_static <- rworkflows::use_workflow(name = "rworkflows_static",
                                     run_bioccheck = FALSE, 
                                     run_rcmdcheck = TRUE,  
                                     run_pkgdown = TRUE, 
                                     run_docker = TRUE,
                                     docker_user = "bschilder",
                                     docker_org = "neurogenomicslab",
                                     force_new = TRUE,
                                     ## Use default save_dir in practice
                                     save_dir = tempdir())

## Saving yaml ==> /var/folders/rd/rbc_wrdj4k3djf3brk6z0_dc0000gp/T//RtmpHZJkFH/rworkflows_static.yml

`use_badges`

This function creates a banner containing badges, a hex sticker (if one is available), and author names.

badges <- rworkflows::use_badges()

## Finding hex sticker(s) for 1 package(s).

## Adding license.

## Adding version.

## Adding code size

## Adding commit.

## Adding actions.

## Adding codecov.

## Adding authors.

## When refs is provided, paths must have the same length (or be set to NULL). Setting paths=NULL.