General Guidelines for Authors
- Each paper takes the form of a Sweave (Rnw) file. These Sweave files are a mixture of R and latex.
- Paper should compile to latex (and then pdf) automatically without further user input or debugging.
- A separate section in each paper states what input data is required. If only a small amount of data is required it can be printed in its entirety. Large amounts of data can be described and the first few lines printed.
- Papers should accept any reasonable input. Whenever possible, bad or unexpected input data should trigger a error message that indicates the specific problem.
- Papers should contain high-quality and well-chosen tables and graphs. How well a technique is presented can be as important as how accurate it is.
Specific Coding Guidelines
- Use the Google R Style Guide. However, the closing brace of an "if" statement shouldn't go on its own line if followed by an else.
- Use ggplot2 for graphing, and favir data frames for latex tables. This will allow results to be easily theme-able across papers.
- The packages plyr and reshape are suggested for data manipulation.
- Each function should be commented. Try to keep functions short, ideally less than 10 statements long.
- Try to use existing packages (especially actuarial ones) instead of reinventing the wheel.
- When in doubt, look at a previous similar paper and copy the style.
page revision: 0, last edited: 24 Mar 2010 02:56