quantlet/styleguide-and-faq

Includes the Styleguide and Frequently Asked Questions (FAQ)

Styleguide and FAQ

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

This repository includes

• Styleguide of Quantlets: It details ...
  • the requirements toward the Quantlet(s) and the accompanying Metainfo.txt file,
  • how to structure your Quantlet(s) within your repository,
  • for additional information see the page styleguide.
• Submission Guide for Members of the Quantlet organization: It details ...
  • how to submit to or change an existing repository,
  • how to fork a repository into the Github Quantlet organization,
  • how to create a new repository.
• Submission Guide for NON Members of the Quantlet organization: It details ...
  • how to submit to an existing repository via pull request,
  • entire repositories can only be forked into the Github Quantlet organisation by a member.

We highly recommend that you first familiarize yourself with the Styleguide, at best before you start structuring.

Contacts for questions, problems, issues, suggestions, ...

If you have questions, problems etc. that are not covered by the given documents,

1. Have a look at our Frequently Asked Questions page.
2. Should the issue remain, we recommend ...
   • students to consult your project supervisor,
   • researchers to consult your cooperating author from the IRTG.
3. For all remaining issues please consult the Quantlet Team.
   • We offer office hours Tuesdays from 10 am to 11 am in Room 110 at Dorotheenstr. 1, 10117 Berlin. Please notify us via [email protected] about before your visit, such that we can organize accordingly.
   • Address your issue to us via [email protected], in that case please always provide your Github username and include links to repositories you are referring to.

Team

• E. Zinovyeva
• J. Winkel
• F. Liu
• B, Raul
• Prof. Dr. W. Härdle

Contact

Quantlet Team
IRTG 1792 'High Dimensional Nonstationary Time Series'

Humboldt University Berlin
School of Business and Economics
Dorotheenstr. 1
10117 Berlin

E-Mail: [email protected]

styleguide-and-faq's Issues

Comments-S

1. The first task should be to check the code, and only afterwards - metainfo.
2. If it's possible, please upload this styleguide as text file, then I could change some lines there or change the order of items, because now it's a little bit not relevant.

Cluster descriptions of Validation procedure around Github functionalities

Describe Workflow and not only the validation procedure.

Workflow on Github via referencing existent training material.
Introduce localclient, to allow for file-uploads.

Reduce complexity for "normal user"

Avoid desktop client and focus only a simple division between workspaces:

1. Github (browser version)
2. R

MetaInfo - Item: Usage (not useful)

The Usage Item of the MetaInfo adds no additional information to the QuantLet. In most cases it contains redundant information which is not preferable. Therefore, I would suggest to ignore/delete that field in all upcoming new QuantLets and integrate that piece of information (if not redundant) in the description tag or the input/output tag.

Update Styleguide + add following

Hi all,
in the past there was a question about the mixed up behavior of tabs and spaces in the source code on Github.

Try it with spaces, because formatR is using spaces.

Sveta wrote:
I have spaces, 4.
However, at bestglm_lambda_down it is spaces, 2.

Should we agree about style by default?
From now on I suggest to choose always the following settings, doesn’t matter if working on the web page or via a Github client and own editor:

Indent mode: Spaces, 4 Characters.

Then it is in accordance to formatR (the same settings).

@theo, Sveta:
Please extend the Styleguide accordingly.

You have also to update the Readme, PDF is not there anymore

@https://github.com/QuantLet/Styleguide-and-Validation-procedure/commit/f8f3987e2d3ef4e7dfb6906383b533c075c017a9

yaml list format

Hey guys, you write that these 2 alternatives are equal:

Keywords: financial, portfolio, returns, asset, time-series, plot
Keywords:

• financial
• portfolio
• returns
• asset
• time-series
• plot

I think they are not, the first alternative should be put into [...] like this:
Keywords: [financial, portfolio, returns, asset, time-series, plot]

Allow for file uploads over indirect way "ISSUES"

It is much easier to drag and drop a png. file into an issue than to install a desktop client, clone repositories, add changes, sync them...

You can also easily save the png. directly of that comment.

PDF doesn't work/open after download

Please check if the file was correctly compliled. It does not work on my PC after downloading.

Incentivize to learn about GitHub by pointing to the benefits of future applications

Everyone who learns about the concept of GitHub, will benefit from these developed skills.

• Collaborate remotely on a project
• benefit from a distributed system and ensure permanent backups of existing work

Mistake in pdf file: wether ->whether

Though I like the joke.

Workflow of validation on Github + Transition of quantlet on github

Styleguide - FormatR package - question

tidy_source(source = "input.R", indent = 2, width.cutoff = 80, file = "output.R")
tidy_source(indent = 2, width.cutoff = 80, file = "output.R")

What for to mention these two examples, if you recommend to use the third one?
tidy_source(file = "output.R")

• Now it's unclear which style should be chosen and why (e.g. indent = 2 as at ex.1, or indent=4 by default at ex.3)
• If smb chooses ex.1 or ex.2, then he'll use the style with indent = 2 (instead of indent=4 which we use now)

I think it'd be better to suggest two options:

• main:
  tidy_source(file = "output.R")
• optional - if smb wants to read it from file:
  tidy_source(source = "input.R", file = "output.R")

Fields "Example" and "Datafile" should be marked as optional