Includes the Styleguide and Frequently Asked Questions (FAQ)
Switch branches/tags
Nothing to show
Clone or download
Latest commit 7680cf8 Nov 30, 2016
Permalink
Failed to load latest commit information.
other clean structure Oct 5, 2016
pictures clean structure Oct 5, 2016
QuantNet2.pdf add new workflow file Oct 4, 2016
README.md update md Oct 5, 2016
Styleguide.md correct typo Nov 30, 2016
TEMPLATE_Metainfo.txt update SG Oct 6, 2016

README.md

Visit QuantNet

Styleguide and FAQ Visit QuantNetVisit QuantNet 2.0

Build software better, together, now (QuantNet 2.0 @ GitHub)

We highly recommend that you first familiarize yourself with the Styleguide and the application of yamldebugger. They will help you to avoid typical problems and strengthen your sense of achievement.

This repository includes:

  • Styleguide of Quantlets for first submission - Styleguide
  • Frequently Asked Questions - FAQ
  • How to format and upload your Quantlet to QuantNet 2.0 - Workflow
  • Template for mandatory file in every QuantLet subfolder of a repository (see also Guideline II):
  • metainfo.txt - Please format your added content according to YAML as described in the Styleguide. Thanks to your effort, we are able to automatically provide a standardized Readme.md to your repository.
  • YAML parser debugger (yamldebugger) according to the QuantNet style guide: the R-Package yamldebugger may be freely used for testing and validating the own Quantlets bevore uploading them into https://github.com/quantlet . Mainly, it checks the validity of the YAML meta information and the completeness of the mandatory data fields as described in Styleguide

Guideline I:

  • Abbreviations
    • Q = Quantlet
    • QNet = Quantnet
    • repo = repository
    • GH = GitHub

Guideline II:

Guideline III: