-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathpcn.sthlp
155 lines (131 loc) · 6.89 KB
/
pcn.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
143
144
145
146
147
148
149
150
151
152
153
154
155
{smcl}
{* *! version 1.0.0 8jan2020}{...}
{cmd:help pcn}{right: WB:PovcalNet Team}{* {right: ({browse "some link":SJ: ???})}}
{hline}
{vieweralsosee "" "--"}{...}
{vieweralsosee "Install wbopendata" "ssc install wbopendata"}{...}
{vieweralsosee "Help wbopendata (if installed)" "help wbopendata"}{...}
{viewerjumpto "Command description" "pcn##desc"}{...}
{viewerjumpto "Parameters description" "pcn##param"}{...}
{viewerjumpto "Options description" "pcn##options"}{...}
{viewerjumpto "Subcommands" "pcn##subcommands"}{...}
{viewerjumpto "Stored results" "pcn##return"}{...}
{viewerjumpto "Examples" "pcn##Examples"}{...}
{viewerjumpto "Disclaimer" "pcn##disclaimer"}{...}
{viewerjumpto "How to cite" "pcn##howtocite"}{...}
{viewerjumpto "References" "pcn##references"}{...}
{viewerjumpto "Acknowledgements" "pcn##acknowled"}{...}
{viewerjumpto "Authors" "pcn##authors"}{...}
{viewerjumpto "Regions" "pcn_countries##regions"}{...}
{viewerjumpto "Countries" "pcn_countries##countries"}{...}
{title:Intro}
{marker top}{...}
{p 4 4 2}{bf:{ul:Description (short)}}{p_end}
{p 4 4 2}
The {cmd:pcn} command through a set of subcommands, allows Stata users to
comprehensively manage the PovcalNet files and folders. By using the command,
the user will be able to, load data into stata, get the main aggregates,
and keep up with updates.{p_end}
{c TLC}{hline 62}{c TRC}
{c |}{col 68}{c |}
{c |} Get ahead with single module help:{col 68}{c |}
{c |}{col 68}{c |}
{c |} 1. To load the povcalnet files into memory, see{col 68}{c |}
{c |} {bf:{help pcn_load: [PCN] pcn load}}{col 68}{c |}
{c |}{col 68}{c |}
{c |} 2. To work with the master file, see{col 68}{c |}
{c |} {bf:{help pcn_master: [PCN] pcn master}}{col 68}{c |}
{c |}{col 68}{c |}
{c |} 3. To work with primus estimates{col 68}{c |}
{c |} and transactions, see{col 68}{c |}
{c |} {bf:{help pcn_primus:[PCN] pcn primus}}{col 68}{c |}
{c |}{col 68}{c |}
{c |} 4. To work with group data, see{col 68}{c |}
{c |} {bf:{help pcn_gd:[PCN] pcn groupdata}}{col 68}{c |}
{c |}{col 68}{c |}
{c |} 5. To create the weights and welfare{col 68}{c |}
{c |} for povcalnet engine, see{col 68}{c |}
{c |} {bf:{help pcn_create:[PCN] pcn create}}{col 68}{c |}
{c |}{col 68}{c |}
{c |} 6. To update the povcalnet files, see{col 68}{c |}
{c |} {bf:{help pcn_download:[PCN] pcn download}}{col 68}{c |}
{c |}{col 68}{c |}
{c |} 7. To check for differences with a server, see:{col 68}{c |}
{c |} {bf:{help pcn_compare:[PCN] pcn compare}}{col 68}{c |}
{c |}{col 68}{c |}
{c |} 8. To load or create production vintages, see:{col 68}{c |}
{c |} {bf:{help pcn_production:[PCN] pcn production}}{col 68}{c |}
{c |}{col 68}{c |}
{c |} Or check out the {bf:{help pcn_full:pcn full help file}}{col 68}{c |}
{c |}{col 68}{c |}
{c BLC}{hline 62}{c BRC}
{p 4 4 2}
{bf: Note: pcn} requires {help missings:missings}, {help datalibweb:datalibweb}
and {help primus:primus}. [Notice: {help datalibweb:datalibweb} and {help primus:primus}
may require World Bank internal resources]
{hline}
{center: {title:Cheat Sheat}}
{hline}
{marker syntax}{...}
{title:Syntax}
{p 8 17 2}
{cmdab:pcn:} [{it:{help pcn##subcommands:subcommand}}] [{cmd:,} {it:{help pcn##subcommands:Parameters}} {it:{help pcn##options:Options}}]
{p 4 4 2} Where parameters, identify the characteristics of the file to be used. {p_end}
{p 4 4 2} {ul:{title:Subcommands}}
The available subcommands are the following:
{col 5}Subcommand{col 30}Description
{space 4}{hline}
{p2colset 5 30 29 2}{...}
{p2col:{opt load}}Loads into memory the file corresponding to the parameters given by
the user.{p_end}
{p2col:{opt master}}Loads or updates the master file sheets.{p_end}
{p2col:{opt create}}Creates a dataset containing weights and welfare.
(Relevant for PovcalNet tools.){p_end}
{p2col:{ul:{opt group}}{opt data}}Creates group data files from raw information and
updates the master file with means.{p_end}
{p2col:{opt download}}(Rarely used). Downloads the latest file(s) available. Should
be only used when major updates are released.{p_end}
{p2col:{opt primus}}Allow you to manage with ease both the pending and approved data on PRIMUS.{p_end}
{space 4}{hline}
{p 4 4 2}
See the {help pcn_full:pcn full help file} for further explanation of the {help pcn_full##subcommands:subcommands}.{p_end}
{p 4 4 2} {ul:{title:Parameters}}
The {bf:pcn} command requires the following parameters:
{col 5}Parameter{col 30}Description
{space 4}{hline}
{p2col:{opt country:}(3-letter code)}List of country codes (accepts multiples) [{it:all} is not accepted]{p_end}
{p2col:{opt years:}(numlist|string)}Four-digit year [all is not accepted] {p_end}
{p2col:{opt type:}(string)}Type of collection requested, only GMD request are accepted.{p_end}
{space 4}{hline}
{p 4 4 2}
See the {help pcn_full:pcn full help file} for further explanation of the {help pcn_full##param:parameters}.{p_end}
{p 4 4 2} {ul:{title:Options}}
The {bf:pcn} command has the following main options available:
{col 5}Option{col 30}Description
{space 4}{hline}
{p2col:{opt clear:}}Replaces data in memory.{p_end}
{p2col:{opt lis:}}Only LIS surveys will be taken into account.{p_end}
{p2col:{opt module:}}It will search accordingly for those either "BIN" or "GPWG"\"GMD" surveys.{p_end}
{p2col:{opt load:}}[Only for master subcommand] If selected the selected sheet will be load from the master.{p_end}
{p2col:{opt upload:}}[Only for master subcommand] If selected the selected sheet will be modified in the master. [Use restricted for the time being.]{p_end}
{space 4}{hline}
{p 4 4 2}
See the {help pcn_full:pcn full help file} for further explanation of the {help pcn_full##options:Options}.{p_end}
{hline}
{marker contact}{...}
{title:Contact}
{pstd}
Any comments, suggestions, or bugs can be reported in the
{browse "https://github.com/worldbank/pcn/issues":GitHub issues page}.
All the files are available in the {browse "https://github.com/worldbank/pcn":GitHub repository}
{title:Author}
{p 4 4 4}R.Andres Castaneda, The World Bank{p_end}
{p 6 6 4}Email {browse "[email protected]":[email protected]}{p_end}
{p 6 6 4}GitHub: {browse "https://github.com/randrescastaneda":randrescastaneda }{p_end}
{p 4 4 4}David L. Vargas Mogollon, The World Bank{p_end}
{p 6 6 4}Email: {browse "[email protected]":[email protected]}{p_end}
{p 6 6 4}GitHub: {browse "https://github.com/davidlvargas":davidlvargas }{p_end}
{title:Maintainer}
{p 4 4 4}David L. Vargas Mogollon, The World Bank{p_end}
{p 6 6 4}Email: {browse "[email protected]":[email protected]}{p_end}
{p 6 6 4}GitHub: {browse "https://github.com/davidlvargas":davidlvargas }{p_end}