This page gives additional information to the Styleguide of Quantlets.
Every Quantlet folder consists of two elementary parts / files:
-
Metainfo.txt:
- Contains meta-information about the functionality, origin and purpose of your Quantlet. Furthermore, lists of keywords and references to other related Quantlets.
- You will need to create a Metainfo.txt file, which will be used for the Quantlet Visualization and data mining practices (e.g. clustering, filtering and recommendation engines) and is therefore mandatory.
- We use YAML to format metainfo.txt to make things easy and fast, YAML is a human-friendly, cross-language data serialization language that can be parsed by a computer. For further information about YAML notations, see YAML.
- You can use the Metainfo.txt template as a blueprint for your Metainfo.txt file. If you are unsure about your Metainfo.txt files parsability, we recommend you to use this page yaml-online-parser.appspot.com to check it.
-
Quantlet code file:
- A correctly working code represents the second elementary part. The described functionality in the Metainfo.txt should practically be realizable by using the provided code.
- Make sure that the provided 'Name of Quantlet' and the actual filename of your provided code file is identical! Otherwise the automatic Readme.md creation will be incomplete.
- If a Quantlet is written in more than one programming language (i.e. Matlab/SAS), add relevant data fields like Author[Matlab], Author[SAS], Submitted[Matlab], Submitted[SAS], ... to the Metainfo.txt if you want to distinguish between different versions/languages.