ghclass (version 0.1.0)

peer_return: Return peer feedback to authors

Description

#' peer_assign adds files from authors' repositories to review repositories. The function creates an issue on the reviewers' repositories informing them that the review files are available and creates links to the relevant documents. peer_return() returns the review files from reviewers' review repositories to authors' repositories. The function i) adds empty rating form (if specified via local_path_rating), ii) moves completed review (if specified via form_review) from reviewer to author, iii) moves assignment files from reviewer to author (if specified via path and changed by reviewer), and iv) opens an issue on authors' repositories informing them about the added files.

Usage

peer_return(
  org,
  roster,
  path,
  form_review = NULL,
  local_path_rating = NULL,
  double_blind = TRUE,
  prefix = "",
  suffix = "",
  message = NULL,
  branch = "master",
  overwrite = FALSE
)

Arguments

org

Character. Name of 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.

path

Character. File name or vector of file names to be included. Cannot be left empty.

form_review

Character. File name of reviewer feedback form (must be .Rmd document). If NULL, no review form will be moved back to authors' repositories.

local_path_rating

Character. Local file path of rating feedback form to be added (must be .Rmd document), defaults to NULL. If NULL, no rating form will be added to authors' repositories.

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 anonymized user IDs in the roster's user_random column. 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, defaults to "Assigning review."

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.

See Also

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

Examples

# NOT RUN {
peer_return(org = "ghclass-test",
roster = "hw2_roster_seed12345.csv",
path = c("hw2_task.Rmd", "iris_data.csv"),
form_review = "hw2_review.Rmd",
local_path_rating = "./hw2/hw2_rating.Rmd",
prefix = "hw2-")
# }
# NOT RUN {
# }