Get Started

Authors: Brian Schilder, Alan Murphy, Nathan Skene

Vignette updated: Jan-12-2023

Contents

library(rworkflows)

1 GitHub Secrets

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

• PAT_GITHUB [Required]: Speeds up installations and gives 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.

2 use_workflow

2.1 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",
                                     ## Use default save_dir in practice
                                     save_dir = tempdir())

## Saving workflow ==> /var/folders/zq/h7mtybc533b1qzkys_ttgpth0000gn/T//Rtmp3K3j0K/rworkflows.yml

2.2 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",
                                     ## Use default save_dir in practice
                                     save_dir = tempdir())

## Saving workflow ==> /var/folders/zq/h7mtybc533b1qzkys_ttgpth0000gn/T//Rtmp3K3j0K/rworkflows_static.yml

3 use_badges

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

badges <- rworkflows::use_badges()

## Adding version.

## Adding actions.

## Adding commit.

## Adding code size

## Adding codecov.

## Adding license.

## Adding authors.