Contribute to the COBRA Toolbox with MATLAB.devTools

Author(s): Ronan M.T. Fleming

Reviewer(s):

INTRODUCTION

This tutorial introduces you to contribution to the development of the COBRA Toolbox with MATLAB.devTools

MATERIALS - EQUIPMENT SETUP

Describe all of the the required software dependencies that are assumed to be in place before the start of this tutorial.

PROCEDURE

Step by step methodology. This is the key section of the tutorial and must be a direct instructions. Use the active tense rather than the passive tense, for example, "Run flux balance analysis", instead of "Flux balance analysis was run". If the protocol naturally breaks into separate stages, then include subheadings and resume the numbered list. Include a TIMING callout with each subheading and state how long the section will take to complete.

Highlight critical steps in the protocol that must be performed in a very precise manner e.g., where the input is crucial or the checking of computational solutions against the literature is required; thus providing the user with hints to maximize the likelihood of success. Make these clear with the heading ‘CRITICAL STEP’, followed by a brief explanation. Include diagrams where appropriate. If the tutorial is complicated you should consider including a flow diagram to demonstrate how the stages fit together.

Where there are alternative routes to reach the next stage of the protocol, please give enough background so that the reader will be able to make an informed decision on the route to choose. Letters of the Latin alphabet (A), B), C)...) should be used to identify the different options, and Roman numerals (i), ii), etc.) should be used to break down the appropriate steps.

1. This step can be performed using option A or option B depending on whether...

A. First option

i. First part

ii. Second part, etc.

B. Second option

i. First part

ii. Second part, etc.

If you wish to include subheadings, add the subheading at the start of the first step within that section and make the text italic. This formatting can also be used to include second level subheadings within the main procedure.

TROUBLESHOOTING

Please include TROUBLESHOOTING callouts after steps where problems are encountered. Include full details of the problem and solutions in a later Troubleshooting section.

TIMING

If possible, please include a timeline indicating the approximate time a step, or set of steps, will take e.g. Steps 1–3, 30 min.; Steps 6+7, 2 h. Provide this information as a summary at the end of the procedure, as a list. If you think it would be more user friendly you could refer to time needed for each section or detail what needs to be performed on each day of the protocol.

TROUBLESHOOTING

After key steps, include information on how to troubleshoot the most likely problems users will encounter with the tutorial. Ideally provide this information in the form ‘problem’, ‘possible reason’, ‘solution’.

ANTICIPATED RESULTS

Include information about, or examples of, the likely outcome to users, for example, likely solution to an optimisation problem, etc. Include example that works very well and a second for that requires troubleshooting to obtain meaningful results. If not described in detail in the introduction, this is a good place to include directions on how to interpret and analyze the computational results including equations if necessary.

Acknowledgments

Please note an acknowledgments section can be included.

REFERENCES

List all references mentioned in the protocol. References are numbered sequentially as they appear in the text, figure legends, tables and boxes. Use superscript numbers to indicate a reference, for example 1 . Only one publication is given for each number, and footnotes are not used. Only papers that have been published or accepted by a named publication should be in the numbered list; meeting abstracts and papers in preparation should be mentioned in the text with a list of authors (or initials if any of the authors are co-authors of the present contribution). Patents should be included in the reference list. Published conference abstracts and URLs for web sites should be cited parenthetically in the text, not in the reference list; articles in formal, peer-reviewed online journals should be included in the reference list. Grant details and acknowledgments are not permitted as numbered references.

All authors should be included in reference lists unless there are more than five, in which case only the first author should be given, followed by 'et al.'. Authors should be listed last name first, followed by a comma and initials of given names. Titles of cited articles are required and should be in Roman text and titles of books in italics; the first word of the title is capitalized, the title written exactly as it appears in the work cited, ending with a period. Journal names are italicized and abbreviated (with periods) according to common usage; refer to the National Library of Medicine for details. Volume numbers appear in bold. For book citations, the publisher and city of publication are required (e.g. John Wiley & Sons, Hoboken, New Jersey, USA, 2003).

List all references mentioned in the protocol. Use the format given in the examples below:

3. Helms, C. et al. A putative RUNX1 binding site variant between SLC9A3R1 and RAT9 is associated with susceptibility to psoriasis. Nat. Genet. 35, 349-356 (2003).

4. Lovett, M. Direct selection of cDNAs with large genomic DNA clones. InMolecular Cloning: A Laboratory Manual Edn. 3 Vol. 2 (eds. Sambrook., J. & Russell, D.W.) 11.98-11.133 (Cold Spring Harbor Laboratory Press, Cold Spring Harbor, New York, USA, 2001).

5. Petroff, M.D. & Stapelbroek, M.G. Blocked impurity band detectors. US Patent 4,586,960 filed 23 Oct. 1980, and issued 4 Feb. 1986.