-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathpcn_primus.sthlp
117 lines (85 loc) · 3.87 KB
/
pcn_primus.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
{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_full##desc"}{...}
{viewerjumpto "Parameters description" "pcn_full##param"}{...}
{viewerjumpto "Options description" "pcn_full##options"}{...}
{viewerjumpto "Subcommands" "pcn_full##subcommands"}{...}
{viewerjumpto "Stored results" "pcn_full##return"}{...}
{viewerjumpto "Examples" "pcn_full##Examples"}{...}
{viewerjumpto "Disclaimer" "pcn_full##disclaimer"}{...}
{viewerjumpto "How to cite" "pcn_full##howtocite"}{...}
{viewerjumpto "References" "pcn_full##references"}{...}
{viewerjumpto "Acknowledgements" "pcn_full##acknowled"}{...}
{viewerjumpto "Authors" "pcn_full##authors"}{...}
{viewerjumpto "Regions" "pcn_countries##regions"}{...}
{viewerjumpto "Countries" "pcn_countries##countries"}{...}
{center:{cmd:pcn} {hline 2} Stata package to manage {ul:{it:PovcalNet}} files and folders.}
{center:{bf:pcn primus}}
{hline}
{center:({help pcn:Go back to Intro page})}
{p2colset 5 30 29 2}{...}
{p 4 4 2}
The {cmd:load} subcommand allows to manage with ease both the pending and approved data on PRIMUS.
{p_end}
{p 4 4 2}
Two different kinds of data be used, accordingly to the chosen companion word:{p_end}
{hline 73}
Subcommand + Companion{col 45}Action
{hline 25}{col 45}{hline 45}
primus approved {col 45}Works with approved data on primus
primus pending {col 45}Works with the pending (not yet approved) data.
{hline 73}
{p 4 4 2}
Options and overall structure is similar independent of the companion word, please keep in mind the following:{p_end}
{p 8 17 2}
{cmdab:pcn:} primus [approved | pending], [ down(estimates|transactions) | load(estimates|transactions) ] {it:{help pcn_full##options:Options}}
{p 4 4 2}
Either {opt load} or {opt down} is required.
{col 5}Option{col 30}Description
{space 4}{hline}
{p2col:{opt load:(estimates|trans)}}If selected the either the primus estimates or transactions IDs will be loaded into memory.{p_end}
{p2col:{opt down:(estimates|trans)}}If selected the either the primus estimates or transactions IDs will be downloaded or updated.{p_end}
{p2col:{opt version:}}If set a particular version of the estimates or transacions will be load on basis
of the date given by the user. If unsure of the date, by writing "choose" or "pick", a list of the versions available will be lunch and the user may select the one to use
trought a clickcable menu. If not set the latest version is used.{p_end}
{space 4}{hline}
{p 4 4 2}
{center:{hline 16}}
{center:{bf:Examples}}
{center:{hline 16}}
{space 4}{hline 15}
{p 4 4 2}
Getting the latest approved estimates:{p_end}
{phang2}
{stata pcn primus approved, load(estimates)}
{p 4 4 2}
Getting the latest approved transactions:{p_end}
{phang2}
{stata pcn primus approved, load(transactions)}
{p 5 4 2}
which is the same as:
{phang2}
{stata pcn primus approved, load(trans)}
{p 4 4 2}
If you need pending data the same holds:{p_end}
{phang2}
{stata pcn primus pending, load(estimates)}
{phang2}
{stata pcn primus pending, load(trans)}
{p 4 4 2}
If you need to load a particular version, keep in mind the {opt version} option:
{phang2}
{stata pcn primus pending, load(trans) version(list)}
{p 4 4 2}
If you need to update the information just use the {opt down} option:
{phang2}
{stata pcn primus pending, down(estimates)}
{phang2}
{stata pcn primus approved, down(trans)}
{center:({help pcn_primus:Go back to top})}
{center:({help pcn:Go back to Intro page})}