2 |
3 |
8 |
9 | **Book Examples** ...
10 |
11 |
12 | Author
13 | ------
14 | **E. F. Haghish, Ph.D.**
15 | Department of Medical Psychology and Medical Sociology,
16 | University of Göttingen, Germany
17 |
18 | _http://www.haghish.com/contact.php_
19 | _[@Haghish](https://twitter.com/Haghish)_
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/Torture_test/Arguments/noisily.do:
--------------------------------------------------------------------------------
1 | // -----------------------------------------------------------------------------
2 | // HTML Document Exportation
3 | // =============================================================================
4 | qui log using example, replace smcl
5 |
6 | /***
7 | This is heading 1
8 | =================
9 |
10 | ======================
99 |
100 | ***/
101 | (note: file /var/folders/b8/v19wyt1d3xngpr03_nc7fbtw0000gn/T//S_08163.000007 not found) . sysuse auto, clear
99 | (1978 Automobile Data)
100 |
101 | . summarize foreign
102 |
103 | Variable | Obs Mean Std. Dev. Min Max
104 | -------------+---------------------------------------------------------
105 | foreign | 74 .2972973 .4601885 0 1
106 |
107 | . scalar c = "Dynamic"
108 |
109 | . local min = `r(min)'
110 |
111 | . scalar max = r(max)The documentation can include numeric and string macros and scalars. For example, the values of the foreign variable range between 0 to 1.
Use a single "$" sign for writing inline mathematical notations. For example, \(f(x)=\sum_{n=0}^\infty\frac{f^{(n)}(a)}{n!}(x-a)^n\) would be rendered inline with the text paragraph. Use double dollar signs "$$" for placing the notations on a separate lines:
91 |\[Y_i = \beta_0 + \beta_1 X_i + \epsilon_i\]
92 |Since the notations appear in comments, they will not be interpreted by Stata as global macros.
Place a backslash before the "$" if you are using them in the document, but not for rendering mathematical notations. The backslash will not appear in the dynamic document.
You can also write dynamic mathematical notations using the txt command.
. local a = 10\[ \beta_1 = 10 \]
99 |Note that when you write inline mathematical notations, there should be NO SPACE between the dollar sign and the notation. However, if you are placing your notations on a separate line, there should be no problem.
100 | 101 | 102 | -------------------------------------------------------------------------------- /Examples/mini/doc.do: -------------------------------------------------------------------------------- 1 | // 1. change the working directory to where this file is saved 2 | // Execute this file with markdoc mini to create dynamic document/slides/sthlp 3 | 4 | /*** 5 | Header 6 | ====== 7 | 8 | something will appear 9 | 10 | --- 11 | 12 | Header 2 13 | -------- 14 | 15 | ### Header 3 16 | 17 | #### Header 4 18 | 19 | ##### Header 5 20 | 21 | --- 22 | 23 | Part 2 24 | ======= 25 | 26 | This is a text paragraph. Text can be *italic* or 27 | _italic_. Also, it can be **Bold** or __Bold__. 28 | 29 | > "the text paragraph can be indented for - typically -quoting " 30 | 31 | - This is item 1 32 | - Item 2 33 | - item 3 34 | - This is another item 35 | - quite file I hope 36 | - continue with the list 37 | 38 | --- 39 | 40 | Numbered list 41 | ============== 42 | 43 | 1. numbered item 1 44 | 2. item 2 45 | 3. back to item 46 | 47 | Using the "---" sign will add a line in the document 48 | 49 | --- 50 | 51 | Breaking the line 52 | ----------------- 53 | 54 | Add 2 or more spaces at the end of the line to break it without 55 | starting 56 | a new 57 | paragraph 58 | 59 | 60 | --- 61 | 62 | 63 | Adding links 64 | ------------- 65 | 66 | You can also add the __hypertext__ e.g. 67 | [MarDoc's Manual](https://github.com/haghish/MarkDoc/wiki) 68 | 69 | --- 70 | 71 | ***/ 72 | 73 | sysuse auto, clear //load auto dataset 74 | 75 | summarize 76 | 77 | /*** 78 | --- 79 | ***/ 80 | 81 | histogram price 82 | graph export price_hist.png, replace width(300) 83 | 84 | /*** 85 | Including a figure 86 | ------------------ 87 | 88 | Next, I include the histogram of the Price variable using 89 | the `histogram` command and the `price` variable. 90 | 91 | --- 92 | 93 |  94 | 95 | ***/ 96 | 97 | 98 | // reloading the same image using `img` command: 99 | 100 | *img using "price_hist.png", title("explain your graph") 101 | 102 | 103 | histogram mpg 104 | 105 | img, title("Figure 2. Histogram of the `mpg` variable") 106 | 107 | 108 | /*** 109 | 110 | --- 111 | 112 | Writing dynamic text 113 | -------------------- 114 | 115 | use the `txt` command to interpret values of macros and scalars: 116 | ***/ 117 | 118 | summarize price 119 | return list 120 | 121 | txt "The number of subject is " r(N) " subjects in the darta set. " 122 | 123 | 124 | /*** 125 | 126 | --- 127 | 128 | creating table 129 | --------------- 130 | 131 | This table is also supported in __sthlp__ help files 132 | 133 | | __Optopns__ | __Discription__ | 134 | |-------------|------------------------------------------------------------------| 135 | | markup(str) | specifies the markup language that is used for documentation | 136 | | title(str) | displays the table description | 137 | | width(int) | specifies the width of the table in HTML and LaTeX | 138 | | height(int) | specifies the height of the table in HTML and LaTeX | 139 | | center | aligns the table to the center of the document in HTML and LaTeX | 140 | | left | aligns the table to the left of the document | 141 | 142 | --- 143 | 144 | Mathematical notations 145 | ====================== 146 | 147 | You can use markdoc to: 148 | 149 | 1. write inline notations (i.e. in the text paragraphs) 150 | 2. on a separate line 151 | 152 | For example, $\sum$ will appear inline whereas $$\sum$$ willbe on another line. 153 | 154 | 155 | ***/ 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | -------------------------------------------------------------------------------- /mini_mode_tests/active_mini_mode/summary.do: -------------------------------------------------------------------------------- 1 | // this document produces the dynamic document passively, because a log-file is 2 | // used to generate the PDF file, instead of a do-file! 3 | 4 | 5 | 6 | qui log using summary, replace 7 | 8 | /*** 9 | 10 | Notes 11 | -------- 12 | 13 | Here are a few important notes 14 | 15 | 1. As I noted, I have a book about `markdoc` that is nearly finished. I will 16 | send the PDF of the book to Dennis and kindly ask him to put send it to all 17 | of participants of the course. The book is very detailed and has many examples, 18 | and giving it to you is the least I can do to appologize from those few who 19 | had issues with installing the software on their computer and could not fully 20 | benefit from the course. I am certain that the book will provide much more 21 | details as well as examples about MarkDoc and will get everyone going. 22 | 23 | 2. `markdoc` has an option named `noisily`. If you are using the GUI, make sure 24 | the box that says `Execute MarkDoc noisily` is not checked. If you check this 25 | box, your report will be very noisy with information you did not ask for, 26 | because this option is for debugging. I remember some people asked me why they 27 | get extra information while others do not... 28 | 29 | 3. On Mac and Linux, the file path is specified with slash. On Microsoft Windows, 30 | with backslash. Therefore, anyone with Microsoft Windows who could not execute 31 | my example of `markdoc ./filename, ...` hat to actually type 32 | `markdoc .\filename, ...` on Microsoft Windows. This was so obvious, yet at the 33 | time of the presentation it didn't occure to me. 34 | 35 | 36 | Summary of Workshop 37 | =================== 38 | 39 | In the workshop, we covered multiple topics regarding `markdoc` package. Most 40 | notably, we learned about: 41 | 42 | 1. Markdown markup language. We also practiced the syntax at John Gruber's 43 | website which wasTo make the do-file really reproducible, we have to make sure it does not access the data that is already loaded in Stata. Think about it, if you execute a do-file on a data that is already loaded and you have been working on it, can you ensure that re-executing the do-file creates the same results again? you might have done some changes outside of the do-file on the data - such as droping a record - which makes the results ireproducible.
93 |The solution would be to run the do-file in a cleared workspace to ensure the do-file does not access the data that is already loaded. MarkDoc can take a do-file and execute the code in a cleared workspace and produce the dynamic document. This is a very different engine compared to rendering a smcl-log to a dynamic document.
94 |If the do-file return an error, MarkDoc still create the dynamic document until the point the error occured. To run this do-file, first load the auto dataset in Stata. Then call markdoc to produce the dynamic document. You should get an error the no variables defined, which means your do-file does not load the data, although the data are loaded in your Stata.
. display "the next command will be an error"96 |
the next command will be an error
97 | . regress price mpg99 |
no variables defined
100 | r(111);
101 |
102 | end of do-file
103 |