new_challenge: Install a new challenge.

In adrtod/rchallenge: A Simple Data Science Challenge System

Description

Install a new challenge.

Usage

new_challenge(
  path = ".",
  out_rmdfile = "challenge.rmd",
  recursive = FALSE,
  overwrite = recursive,
  quiet = FALSE,
  showWarnings = FALSE,
  template = c("en", "fr"),
  data_dir = "data",
  submissions_dir = "submissions",
  hist_dir = "history",
  install_data = TRUE,
  baseline = "baseline",
  add_baseline = install_data,
  clear_history = overwrite,
  title = "Challenge",
  author = "",
  date = "",
  email = "[e-mail]",
  date_start = format(Sys.Date(), "%d %b %Y"),
  deadline = paste(Sys.Date() + 90, "23:59:59"),
  data_list = data_split(get_data("german"))
)

Arguments

path	string. install path of the challenge (should be somewhere in your Dropbox).
out_rmdfile	string. name of the output R Markdown file.
recursive	logical. should elements of the path other than the last be created? see dir.create.
overwrite	logical. should existing destination files be overwritten? see file.copy.
quiet	logical. deactivate text output.
showWarnings	logical. should the warnings on failure be shown? see dir.create.
template	string. name of the template R Markdown script to be installed. Two choices are available: "en" (english) and "fr" (french).
data_dir	string. subdirectory of the data.
submissions_dir	string. subdirectory of the submissions. see store_new_submissions.
hist_dir	string. subdirectory of the history. see store_new_submissions.
install_data	logical. activate installation of the data files of the template challenge.
baseline	string. name of the team considered as the baseline.
add_baseline	logical. activate installation of baseline submission files of the template challenge.
clear_history	logical. activate deletion of the existing history folder.
title	string. title displayed on the webpage.
author	string. author displayed on the webpage.
date	string. date displayed on the webpage.
email	string. email of the challenge administrator.
date_start	string. start date of the challenge.
deadline	string. deadline of the challenge.
data_list	list with members train, test, y_test and ind_quiz such as returned by the data_split function.

Value

The path of the created challenge is returned.

Examples

path <- tempdir()
wd <- setwd(path)
# english version
new_challenge()
# french version
new_challenge(template = "fr")
setwd(wd)
unlink(path)

adrtod/rchallenge documentation built on March 23, 2021, 7:43 a.m.