-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathcheckdim.sthlp
142 lines (111 loc) · 3.85 KB
/
checkdim.sthlp
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
{smcl}
{* *! version 1.0 19 Aug 2019}{...}
{vieweralsosee "" "--"}{...}
{vieweralsosee "Install checkdim" "ssc install checkdim"}{...}
{vieweralsosee "Help checkdim (if installed)" "help checkdim"}{...}
{viewerjumpto "Syntax" "checkdim##syntax"}{...}
{viewerjumpto "Description" "checkdim##description"}{...}
{viewerjumpto "Options" "checkdim##options"}{...}
{viewerjumpto "Remarks" "checkdim##remarks"}{...}
{viewerjumpto "Examples" "checkdim##examples"}{...}
{title:Title}
{phang}
{bf:checkdim2} {hline 2} Check if variable(s) exist(s) for all values of another variable
{marker syntax}{...}
{title:Syntax}
{p 8 17 2}
{cmdab:checkdim}
[{help varlist}]
[{help in}]
[{cmd:,}
{it:options}]
{synoptset 20 tabbed}{...}
{synopthdr}
{synoptline}
{syntab:Main}
{synopt:{opt dim:ension(varname)}} the variable for which all values are checked. Currently only one dimension possible but extension to more variables in one go possible.
{pstd}
{p_end}
{synopt:{opt no:show}} do not show the results
{pstd}
{p_end}
{synopt:{opt drop}} drop if the drop condition is met
{pstd}
{p_end}
{synopt:{opt dropcond:ition(string)}} the condition for which variable(s) should be dropped.
{pstd}
{p_end}
{synopt:{opt showcond:ition(string)}} the condition for which variables should be shown.
{pstd}
{p_end}
{synopt:{opt sort}} sort the results in descending order.
{pstd}
{p_end}
{synopt:{opt keep}} keep the generated variables
{pstd}
{p_end}
{synopt:{opt keepn:ame(string)}} the stub for the generated variables. The default stub is "mis".
{pstd}
{p_end}
{synopt:{opt replace}} replace existing variables which contain the results.
{pstd}
{p_end}
{synoptline}
{p2colreset}{...}
{p 4 6 2}
{marker description}{...}
{title:Description}
{pstd}
{cmd:checkdim2} allows you to check if a variable or multiple variables has/have missing values for all values of another variable/dimension. The results are saved in temporary variables which can be made permanent. The results can be replayed if the {opt keep} has been specified in the first run of the command. To replay the results, just type {cmd:checkdim2} without the dimension and any variables. It is possible to filter the output by using the {opt showcondition()} option. Variables can also be dropped based on the results by using the options {opt drop} and {opt dropcondition()} together.
{pstd}
{marker options}{...}
{title:Options}
{dlgtab:Main}
{phang}
{opt dim:ension(varname)} the variable for which all values are checked. Currently only one dimension possible but extension to more variables in one go possible.
{pstd}
{p_end}
{phang}
{opt no:show} do not show the results
{pstd}
{p_end}
{phang}
{opt drop} drop if the drop condition is met
{pstd}
{p_end}
{phang}
{opt dropcond:ition(string)} the condition for which variable(s) should be dropped.
{pstd}
{p_end}
{phang}
{opt showcond:ition(string)} the condition for which variables should be shown.
{pstd}
{p_end}
{phang}
{opt sort} sort the results in descending order.
{pstd}
{p_end}
{phang}
{opt keep} keep the generated variables
{pstd}
{p_end}
{phang}
{opt keepn:ame(string)} the stub for the generated variables. The default stub is "mis".
{pstd}
{p_end}
{phang}
{opt replace} replace replace existing variables which contain the results.
{pstd}
{p_end}
{marker examples}{...}
{title:Examples}
{pstd}
{title:Stored results}
{synoptset 15 tabbed}{...}
{p2col 5 15 19 2: Locals}{p_end}
{synopt:{cmd:r(dropvar)}} list of dropped variables {p_end}
{synopt:{cmd:r(dropcondition)}} the condition under which variables are dropped. {p_end}
{synopt:{cmd:r(showcondition)}} the condition for which variables should be shown. {p_end}
{synopt:{cmd:r(keepname)}} the stub for the generated variables {p_end}
{title:Author}
{p}