Further documentation is available in the Reference manual.
Please report bugs, troubles or discussions on the Issues tracker. Any contribution to improve the package is welcome.
Install the R package from CRAN repositories
or install the latest development version from GitHub
Install a new challenge in
or for a french version:
You will obtain a ready-to-use challenge in the folder
challenge.rmd: template R Markdown script for the webpage.
data: directory of the data containing
submissions: directory of the submissions. It will contain one subdirectory per team where they can submit their submissions. The subdirectories are shared with Dropbox.
history: directory where the submissions history is stored.
The default challenge provided is a binary classification problem on the German Credit data set.
You can easily customize the challenge in two ways:
datasubdirectory and the baseline predictions in
submissions/baselineand by customizing the template
To complete the installation:
Create and share subdirectories in
submissions for each team:
R ?new_team new_team("team_foo", "team_bar")
Render the HTML page:
R ?publish publish() Use the
output_dir argument to change the output directory. Make sure the output HTML file is rendered, e.g. using GitHub Pages.
Give the URL to your HTML file to the participants.
Refresh the webpage by repeating step 2 on a regular basis. See below for automating this step.
From now on, a fully autonomous challenge system is set up requiring no further administration. With each update, the program automatically performs the following tasks using the functions available in our package:
store_new_submissionsreads submitted files and save new files in the history.
print_readerrdisplays any read errors.
compute_metricscalculates the scores for each submission in the history.
get_bestgets the highest score per team.
print_leaderboarddisplays the leaderboard.
plot_historyplots a chart of score evolution per team.
plot_activityplots a chart of activity per team.
You can setup the following line to your crontab using
crontab -e (mind the quotes):
0 * * * * Rscript -e 'rchallenge::publish("~/Dropbox/mychallenge/challenge.rmd")'
This will render a HTML webpage every hour. Use the
output_dir argument to change the output directory.
If your challenge is hosted on a Github repository you can automate the push:
0 * * * * cd ~/Dropbox/mychallenge && Rscript -e 'rchallenge::publish()' && git commit -m "update html" index.html && git push
You might have to add the path to Rscript and pandoc at the beginning of your crontab:
Depending on your system or pandoc version you might also have to explicitly add the encoding option to the command:
0 * * * * Rscript -e 'rchallenge::publish("~/Dropbox/mychallenge/challenge.rmd", encoding = "utf8")'
You can use the Task Scheduler to create a new task with a Start a program action with the settings (mind the quotes):
Credit approval (in french) by Adrien Todeschini (Bordeaux).
Spam filter (in french) by Marie Chavent (Bordeaux).
Please contact me to add yours.
Copyright (C) 2014-2015 Adrien Todeschini.
Contributions from Robin Genuer.
The rchallenge package is licensed under the GPLv2 (https://www.gnu.org/licenses/gpl-2.0.html).