ghclass (version 0.1.0)

peer_file_add_aut: Add local files to reviewer-specific folders on authors' repositories

Description

peer_file_add_aut() takes a local file and adds it to reviewer-specific folders on authors' repositories. The function's main purpose is to distribute rating forms into the reviewer-specific folders on authors' repositories.

Usage

peer_file_add_aut(
  org,
  roster,
  local_path,
  double_blind = TRUE,
  prefix = "",
  suffix = "",
  message = NULL,
  branch = "master",
  overwrite = FALSE,
  verbose = TRUE
)

Arguments

org

Character. Name of the GitHub organization.

roster

Character. Data frame or file path of roster file with author-reviewer assignments. Must contain a column user with GitHub user names of authors, a column user_random with randomized tokens for user names, and one or more rev* columns that specify review assignments as values of the vector user_random.

local_path

Character. File name of file to be added.

double_blind

Logical. Specifies whether review is conducted double-blind (i.e. neither reviewer nor author can identify each other), or single-blind (i.e. authors remain anonymous but reviewer identities are revealed). If double_blind = TRUE, reviewer folders are identified by the reviewer's ID. If double_blind = FALSE, reviewer folders are identified by the original user names. Defaults to TRUE.

prefix

Character. Common repository name prefix.

suffix

Character. Common repository name suffix.

message

Character. Commit message.

branch

Character. Name of branch the file should be committed to, defaults to master.

overwrite

Logical. Whether existing files in reviewers' repositories should be overwritten, defaults to FALSE.

verbose

Logical. Should success/failure messages be printed, defaults to TRUE.

See Also

Other peer review functions: peer_assign(), peer_file_add_rev(), peer_form_create_rating(), peer_form_create_review(), peer_init(), peer_return(), peer_roster_create(), peer_score_rating(), peer_score_review()

Examples

# NOT RUN {
peer_file_add_aut(org = "ghclass-test",
roster = "hw2_roster_seed12345.csv",
local_path = "/Users/profx/introstats/hw2/hw2_rating.Rmd",
prefix = prefix)
# }
# NOT RUN {
# }