pull_hw: Pull to student repos

In jmcvw/ccmisc: Some misc functions for working at CodeClan

Pull to student repos

Description

Update student homework repositories.

Usage

pull_hw(hw_dir, cohort = "")

Arguments

hw_dir	Character; Path to homework directory
cohort	Character; Cohort directory

Details

The returned result is a list of [ git response stuff that i should probably detail more precisely ], named according to the CodeClan naming convention for student homework repositories. The path provided to hw_dir can be the path to a single repository, or a directory containing one or more repositories. In the latter case, the cohort parameter may also be used to specify a sub-directory.

Value

List, named by student, containing information on the result of the pull operation. This is returned invisibly, so if it is required, it should be assigned

Examples

## Not run: 
  hw_root_dir <- '/Users/user/Documents/GitHub/homework'
  cohort <- 'de999'
  pull_response <- pull_hw(c('zzz', hw_root_dir), cohort) # 'zzz' fails

## End(Not run)

jmcvw/ccmisc documentation built on July 27, 2022, 1:48 a.m.