ghclass (version 0.1.0)

peer_init: Initiate peer review repositories

Description

peer_init() initiates peer review repositories. It creates a review repository for each user, adds users to their respective repositories, and applies peer review labels to all repositories (i.e. assignment and review repositories).

Usage

peer_init(
  org,
  roster,
  prefix = "",
  suffix = "",
  verbose = FALSE,
  show_label_result = 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.

prefix

Character. Common repository name prefix.

suffix

Character. Common repository name suffix.

verbose

Logical. Whether information about label creation should be given, defaults to FALSE. Issues can still be created even labels were not applied to a particular repository.

show_label_result

Logical. Whether a tibble with details on the creation of labels should be returned, 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_return(), peer_roster_create(), peer_score_rating(), peer_score_review()

Examples

# NOT RUN {
peer_init(org = "ghclass-test", roster = "roster_test", prefix = "hw2-")
# }
# NOT RUN {
# }