forked from opencobra/COBRA.tutorials
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tutorial_template.m
117 lines (117 loc) · 6.34 KB
/
tutorial_template.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
%% Tutorial Title
%% Author(s):
%% Reviewer(s):
% This format for a tutorial is based on the Nature Protocol.
%% INTRODUCTION
% _The purpose of the introduction is to enable readers to make a decision as
% to the suitability of the protocol to their problem. Initially you should introduce
% the technique under discussion. Include references to key papers where the protocol
% has been used previously, including those published by your own group or to
% reviews that discuss applications of the technique (see below for how to cite
% references)._
%% 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 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:_
%
% _1. 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)._
%
% _2. 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)._
%
% _3. Petroff, M.D. & Stapelbroek, M.G. Blocked impurity band detectors. US
% Patent 4,586,960 filed 23 Oct. 1980, and issued 4 Feb. 1986._
%
%