Create a new RevBayes analysis repository

Source: R/RevBayes.R

MakeRepo() establishes a new private GitHub repository for a given project–script combination. The repository will host all RevBayes scripts and associated matrix files required for downstream analysis.

MakeRepo(pID, scriptID)

Arguments

pID

Character specifying the project identifier to analyse

scriptID

Character specifying the script to run

Value

MakeRepo() invisibly returns TRUE when the repository has been created and initialized successfully. The function is called primarily for its side-effect of establishing a corresponding GitHub repository and local working copy.

Details

Before using this function, ensure that:

  1. The GitHub CLI (gh) is installed and on your system PATH.

  2. You are authenticated with write access to the account specified in .Renviron as:

    
  ntGithubAccount=neo-trans

  3. You have configured your .Renviron file with SSH details for your analysis cluster (see below).

Typical .Renviron entries (Windows paths shown) are:


sshLogin=username@remote-host
sshKey=C:/Users/you/.ssh/id_ed25519
sshPass=key-passphrase
rb.exe=C:/Program Files/revbayes-vX.Y.Z/bin/rb.exe

You can edit this file by running usethis::edit_r_environ() and must restart R for changes to take effect.

On success, a new repository named <ntGithubAccount>/<project>_<script>.git is created on GitHub and cloned locally to the appropriate subdirectory.

See also

RevBayes(), EnqueueMC(), EnqueueML(), and the zzz.R startup configuration notes for authentication setup.