|
30 | 30 | * |
31 | 31 | * DEPENDENCIES: |
32 | 32 | * After installing flowchart, be sure the following are in place: |
33 | | -* 1. texdoc - STATA Command |
| 33 | +* 1. texdoc, sjlatex - STATA Packages |
34 | 34 | * Installation Instructions: |
35 | | -* In the STATA command-line, run the following 2 commands: |
36 | | -* ssc install texdoc, replace |
37 | | -* net install sjlatex, from(http://www.stata-journal.com/production) |
38 | | -* 2. figure.texdoc = Ancillary File |
| 35 | +* In the STATA command-line, run the following command: |
| 36 | +* flowchart setup |
| 37 | +* This installs 2 dependencies: texdoc and its dependency, sjlatex |
| 38 | +* 2. figure-flowchart.texdoc = Ancillary File |
39 | 39 | * Installation Instructions: |
40 | | -* In the STATA command-line, run the following command: |
41 | | -* net get flowchart, from(https://raw.github.com/IsaacDodd/flowchart/) |
42 | | -* This will install all of the Ancillary Files to your working directory. |
| 40 | +* In the STATA command-line, when you ran the setup command, it also |
| 41 | +* installed the Ancillary Files into your present working directory. |
43 | 42 | * 3. LaTeX Setup (Typesetting) |
44 | 43 | * A LaTeX setup should be installed to compile .tex and .tikz files: |
45 | 44 | * a) Distribution (MiKTeX or TeXLive) |
46 | 45 | * Recommended: MiKTeX, then use it to install the following packages: |
47 | | -* datatool, listings, multicols, xcolor, graphicx, tikz |
| 46 | +* datatool, listings, multicol, xcolor, graphicx, tikz |
48 | 47 | * Download: https://miktex.org/download/ |
49 | 48 | * b) Distribution Engine |
50 | 49 | * Recommended: pdfLaTeX |
|
80 | 79 | * |
81 | 80 | * /Manuscript/ |
82 | 81 | * | |
| 82 | +* |-- ##-[ProjectName]-[Main-Manuscript-File].tex <-- LaTeX Document |
83 | 83 | * |-- ##-[ProjectName]-[Section]-Fig-[FigureName].tex <-- LaTeX Document |
84 | 84 | * +-- ##-[ProjectName]-[Section]-Fig-[FigureName].tikz <-- TikZ Picture |
85 | 85 | * |
|
120 | 120 | * Do File |
121 | 121 | * This is the .do file that contains your analysis where you can use |
122 | 122 | * the flowchart commands to generate the diagram. |
123 | | -* See Example: example.do |
124 | | -* LaTeX Document |
| 123 | +* See Example: flowchart_example2.do |
| 124 | +* LaTeX Documents |
125 | 125 | * This is a (.tex) file that contains a \begin{figure}...\end{figure} |
126 | 126 | * Environment command. STATA does not manipulate this file. It instead |
127 | 127 | * contains all of the design elements that arrange the TikZ picture |
128 | | -* appropriately in the Manuscrupt and also loads the Subanalysis Data |
| 128 | +* appropriately in the Manuscript and also loads the Subanalysis Data |
129 | 129 | * (.data) in the Data file for generating the different components of the |
130 | 130 | * TikZ picture's diagram (e.g., data for the boxes of a |
131 | 131 | * Subject Disposition Flowchart). |
| 132 | +* See Example: methods--figure-flowchart.tex |
| 133 | +* The manuscript's .tex file can then include this .tex file specific to |
| 134 | +* the figure directly into the manuscript file with an \input{ } command: |
| 135 | +* \input{methods--figure-flowchart.tex} |
132 | 136 | * See Example: manuscript.tex |
133 | 137 | * Figure Texdoc Do File - Do Not Edit |
134 | 138 | * This Do file is a 'Texdoc Do File' which is to say it is invoked by the |
135 | 139 | * texdoc command in STATA in the Main Analysis File that is producing the |
136 | | -* Subanalysis Data created from your analysis using your dataset. |
137 | | -* See Example: figure-flowchart.texdoc |
| 140 | +* Subanalysis Data created from your analysis using your dataset. There's |
| 141 | +* no need to edit this file beyond changing its filename to match your |
| 142 | +* project's naming convention. |
| 143 | +* See Example: figure-flowchart.texdoc (No Need to Edit) |
138 | 144 | * TikZ Picture (Automatically regenerated) |
139 | 145 | * This is a 'picture' that is used by the TikZ package in LaTeX to |
140 | | -* generate a diagram in LaTeX. |
141 | | -* See Example: methods--figure-flowchart.tikz |
| 146 | +* generate a diagram in LaTeX. There's no need to edit this file beyond |
| 147 | +* changing its filename to match your project's naming convention. |
| 148 | +* Instead, in your LaTeX document, use the \input{<filename.tikz>} to |
| 149 | +* make LaTeX automatically include it in the final document when |
| 150 | +* compiling. |
| 151 | +* See Example: methods--figure-flowchart.tikz (No Need to Edit) |
142 | 152 | * Subanalysis Data File (Automatically regenerated) |
143 | 153 | * The data for a figure is produced from a subanalysis and is assigned to |
144 | 154 | * variables. The Data file consists of variables with the generated data, |
|
148 | 158 | * the subanalysis. The variables with data produced by the subanalysis |
149 | 159 | * have to have a unique name and are given a name in the do file that |
150 | 160 | * produces the figure. Data from the Dataset used in an analysis can be |
151 | | -* used to generate the data for the diagram. |
152 | | -* See Example: methods--figure-flowchart.data |
| 161 | +* used to generate the data for the diagram. There's no need to edit the |
| 162 | +* file beyond changing its filename to match your project's naming |
| 163 | +* convention. |
| 164 | +* See Example: methods--figure-flowchart.data (No Need to Edit) |
153 | 165 | * |
154 | 166 | * OVERALL: |
155 | 167 | * |
|
0 commit comments