Skip to content

Commit c3c61cd

Browse files
milkomilko
committed
Working on acquiring DHS indicators.
The script is being tested.
1 parent 0aab3e9 commit c3c61cd

9 files changed

+963
-391
lines changed

‎.idea/workspace.xml

+143-139
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎batch/DHS.php

+512-224
Large diffs are not rendered by default.

‎batch/InitDHS.php

+44-9
Original file line numberDiff line numberDiff line change
@@ -73,29 +73,64 @@
7373
//
7474
// Initialise DHS object.
7575
//
76-
echo( "- Initialising data dictionary: ......... " );
76+
echo( "- Initialising data dictionary: .......... " );
7777
$dhs = new DHS( doINIT );
7878
echo( "Done.\n" );
7979

8080
//
8181
// Initialise DHS namespaces.
8282
//
83-
echo( "- Initialising DHS namespaces: .......... " );
84-
$dhs->InitTypes();
83+
echo( "- Initialising DHS namespaces: ........... " );
84+
$dhs->InitNamespaces();
8585
echo( "Done.\n" );
8686

8787
//
88-
// Initialise DHS indicator descriptors.
88+
// Initialise DHS descriptors.
8989
//
90-
echo( "- Initialising DHS indicator descriptors: " );
91-
$dhs->InitIndicators();
90+
echo( "- Initialising DHS descriptors: .......... " );
91+
$dhs->InitDescriptors();
92+
echo( "Done.\n" );
93+
94+
//
95+
// Initialise DHS countries.
96+
//
97+
echo( "- Initialising DHS countries: ............ " );
98+
$dhs->InitCountries();
99+
echo( "Done.\n" );
100+
101+
//
102+
// Initialise DHS measurement types.
103+
//
104+
echo( "- Initialising DHS measurement types: .... " );
105+
$dhs->InitMeasurementTypes();
106+
echo( "Done.\n" );
107+
108+
//
109+
// Initialise DHS indicator types.
110+
//
111+
echo( "- Initialising DHS indicator types: ...... " );
112+
$dhs->InitIndicatorTypes();
113+
echo( "Done.\n" );
114+
115+
//
116+
// Initialise DHS survey characteristics.
117+
//
118+
echo( "- Initialising DHS survey characteristics: " );
119+
$dhs->InitSurveyCharacteristics();
92120
echo( "Done.\n" );
93121

94122
//
95-
// Initialise DHS data descriptors.
123+
// Initialise DHS tags.
96124
//
97-
echo( "- Initialising DHS data descriptors: .... " );
98-
$dhs->InitDataIndicators();
125+
echo( "- Initialising DHS tags: ................. " );
126+
$dhs->InitTags();
127+
echo( "Done.\n" );
128+
129+
//
130+
// Initialise DHS indicators.
131+
//
132+
echo( "- Initialising DHS indicators: ........... " );
133+
$dhs->InitIndicators();
99134
echo( "Done.\n" );
100135

101136

‎composer.lock

+6-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎data/Indicators.dhs.csv

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
ByLabels,"Formerly the set of labels for different universes within the indicator, e.g. All women, Currently Married Women. No longer used.",:type:mixed,:kind:discrete
2+
ByVariableId,"A characteristic ID identifying a further level of disaggregation, when an indicator is disaggregated in multiple ways. For example, Current Use of Contraception is disaggregated by Age, but also for All women, currently married women and sexually active unmarried women. Age is presented in the characteristic category above; the disaggregation for All women, currently married women and sexually active unmarried women is captured in the ByVariableId and ByVariableLabel. If this additional level of disaggregation is not used for the indicator the ByVariableId will be 0 and the ByVariableLabel will be blank. A common use of the ByVariableId and ByVariable...",:type:string,:kind:discrete
3+
ByVariableLabel,The descriptive label for the level of disaggregation provided in the ByVariableId.,:type:string,:kind:discrete
4+
CharacteristicCategory,DHS has defined a list of characteristic categories that are used across surveys to make sure the data can be compared across countries very easily. This category can be used to filter data. See also CharacteristicLabel.,:type:string,":kind:categorical,:kind:summary"
5+
CharacteristicId,DHS has defined a list of characteristics that are used across surveys to make sure the data can be compared across countries very easily. A characteristic ID gives you the unique ID that represents that particular characteristic.,:type:string,":kind:categorical,:kind:summary"
6+
CharacteristicLabel,"This field provides label of the characteristic within a particular characteristic category. For example, Urban and Rural are the two characteristics within the category Residence.",:type:string,:kind:discrete
7+
CharacteristicOrder,Sort order in which to display characteristics.,:type:int,:kind:discrete
8+
CIHigh,The upper bound of the 95% confidence interval for the indicator. The confidence interval is only presented for the maternal mortality ratio and the HIV prevalence indicators.,:type:float,:kind:quantitative
9+
CILow,The upper bound of the 95% confidence interval for the indicator. The confidence interval is only presented for the maternal mortality ratio and the HIV prevalence indicators.,:type:float,:kind:quantitative
10+
CountryName,DHS specific country name.,:type:string,:kind:discrete
11+
DataId,A unique numeric record ID corresponding to the data record provided.,:type:int,:kind:discrete
12+
Definition,Provides a definition of the specified indicator. The definition can be used to provide detailed information to your users.,:type:string,:kind:discrete
13+
Denominator,Provides a definition of the denominator of the specified indicator. The denominator definition can be used to provide detailed information to your users.,:type:string,:kind:discrete
14+
DenominatorUnweighted,The unweighted denominator for the indicator data.,:type:float,:kind:quantitative
15+
DenominatorWeighted,The weighted denominator for the indicator data.,:type:float,:kind:quantitative
16+
DHS_CountryCode,Two-letter DHS specific country code.,:type:enum,:kind:categorical
17+
FieldworkEnd,The month and year of the end of fieldwork for the survey (note: day is always returned as 1).,:type:string,:kind:quantitative
18+
FieldworkStart,The month and year of the start of fieldwork for the survey (note: day is always returned as 1).,:type:string,:kind:quantitative
19+
FIPS_countryCode,Federal Information Processing Standards(FIPS) specific country code.,:type:string,:kind:discrete
20+
Footnotes,Footnotes about the survey.,:type:string,:kind:discrete
21+
ImplementingOrg,The name of the implementing organization(s) for the survey.,:type:string,:kind:discrete
22+
Indicator,The name or label of the particular indicator for this data.,:type:string,:kind:discrete
23+
IndicatorId,Indicator ID for the specified indicator. Each indicator will always have a unique ID and can be used across surveys.,:type:string,:kind:discrete
24+
IndicatorId,Indicator ID for the specified indicator. Each indicator will always have a unique ID and can be used across surveys.,:type:string,:kind:discrete
25+
IndicatorName,Indicator label describing the specified indicator.,:type:string,:kind:discrete
26+
IndicatorOldId,Provides the old numeric ID for the indicator used in API version 1. Available for legacy usage/support only.,:type:string,:kind:discrete
27+
IndicatorOrder,Indicator Order is used for ordering indicators within the levels.,:type:int,:kind:discrete
28+
IndicatorType,Type of indicator. ,:type:enum,:kind:categorical
29+
InfoType,Describing the type of information that was requested.,:type:string,:kind:discrete
30+
Interface,Interface Type of each update.,:type:string,":kind:categorical,:kind:summary"
31+
ISO2_countryCode,International Organization of Standards(ISO) specific two-letter country code.,:type:string,:kind:discrete
32+
ISO3_countryCode,International Organization of Standards(ISO) specific three-letter country code.,:type:string,:kind:discrete
33+
IsPreferred,"If a particular indicator has multiple values because it is disaggregated in multiple ways, this column will identify which is the preferred value to display by default.",:type:bool,:kind:discrete
34+
IsQuickStat,This column will display a '1' for DHS Quickstat indicators that are used or viewed most often. The information can be utilized to serve the most common data to users quickly.,:type:bool,:kind:discrete
35+
IsTotal,This column will identify if a certain value is a Total value used for national totals.,:type:bool,:kind:discrete
36+
Label,Indicator label describing the specified indicator.,:type:string,:kind:discrete
37+
Level1,Each indicator is grouped in a three level hierarchy. This column provides the top level grouping and is the major subject area.,:type:string,":kind:categorical,:kind:summary"
38+
Level2,Each indicator is grouped in a three level hierarchy. This column provides the second level grouping and is the topic area within the major subject.,:type:string,":kind:categorical,:kind:summary"
39+
Level3,"Each indicator is grouped in a three level hierarchy. This column provides the third level grouping and is the universe for the topic (typically Women, Men, Both Sexes, Children, Households, Population).",:type:string,":kind:categorical,:kind:summary"
40+
MaxAgeMen,The maximum age of men included in the survey (typically 49/54/59/64 years).,:type:int,:kind:quantitative
41+
MaxAgeWomen,The maximum age of women included in the survey (typically 49 years).,:type:int,:kind:quantitative
42+
MeasurementType,Specifies the type of measurement. ,:type:enum,:kind:categorical
43+
MinAgeMen,The minimum age of men included in the survey (typically 15 years).,:type:int,:kind:quantitative
44+
MinAgeWomen,The minimum age of women included in the survey (typically 15 years).,:type:int,:kind:quantitative
45+
NumberOfFacilities,"For SPA or service availability surveys, the number of health facilities visited.",:type:int,:kind:quantitative
46+
NumberofHouseholds,The total number of households interviewed in the survey.,:type:int,:kind:quantitative
47+
NumberOfMen,The total number of men interviewed in the survey.,:type:int,:kind:quantitative
48+
NumberOfSamplePoints,The number of sample points (or clusters/enumeration areas) visited in the survey.,:type:int,:kind:quantitative
49+
NumberOfWomen,The total number of women interviewed in the survey.,:type:int,:kind:quantitative
50+
NumberScale,Number Scale provides the precision (number of decimal places) that should be presented for the indicator.,:type:int,:kind:discrete
51+
Precision,The number of decimal places that should be presented for value of the indicator.,:type:int,:kind:discrete
52+
PublicationDate,Date specifying when the survey data was published.,:type:string,:kind:quantitative
53+
PublicationDescription,Detailed description of the publication.,:type:string,:kind:discrete
54+
PublicationID,Unique numeric ID for each publication.,:type:int,:kind:discrete
55+
PublicationSize,Size in bytes of the publication PDF file.,:type:int,:kind:quantitative
56+
PublicationTitle,Title for the publication.,:type:string,:kind:discrete
57+
PublicationURL,The URL providing access to the publication.,:type:string:url,:kind:discrete
58+
QuickStatOrder,This column will provide an integer to help provide a special sort order for all the Quickstat Indicators. These are indicators that display a '1' in the IsQuickStat column and are used or viewed most often. The information can be utilized to serve the most common data to users quickly.,:type:int,:kind:discrete
59+
RegionId,Unique ID given to each survey and region.,:type:string,":kind:categorical,:kind:summary"
60+
RegionName,The region name for the surveys (countries) returned as a result of a specific query. E.g. region name for Egypt is North Africa/West Asia/Europe,:type:string,":kind:categorical,:kind:summary"
61+
RegionOrder,A numeric value that can be used for ordering regions/sub-regions in a list.,:type:int,:kind:discrete
62+
ReleaseDate,Date specifying when the survey data was made available.,:type:string,:kind:quantitative
63+
Removed,"Indicating whether the survey or indicator was removed. 0 = Added/Updated, 1 = Removed.",:type:string,":kind:categorical,:kind:summary"
64+
RowNumber,A unique to identify each row,:type:int,:kind:discrete
65+
SDRID,This column contains the Spatial Data Repository Indicator ID.,:type:int,:kind:discrete
66+
ShortName,Provides a short name for the specified indicator that can be used when displaying the indicator within the hierarchy level if the indicator label is too long. If space is available we recommend using the indicator label.,:type:string,:kind:discrete
67+
SubRegionName,The sub region name for the surveys (countries) returned as a result of a specific query. E.g. Egypt is in the North Africa sub region.,:type:string,":kind:categorical,:kind:summary"
68+
SurveyCharacteristicID,Numeric survey characteristic ID.,:type:string,:kind:discrete
69+
SurveyCharacteristicIds,"A list of IDs for the survey characteristics that includes additional topics, modules or features that were included in the survey beyond the standard. See the survey characteristics for the descriptions associated with each ID.",:type:enum-set,:kind:categorical
70+
SurveyCharacteristicName,"Name of the survey characteristic (topic, module, or feature)",:type:string,:kind:discrete
71+
SurveyId,"DHS survey ID. Each survey will always have a unique ID (of the form ccyyyyttt where cc is the DHS country code, yyyy is the survey year, and ttt is the survey type) and can be used to obtain national or subnational data for a particular survey.",:type:string,:kind:discrete
72+
SurveyNum,Unique numeric id assigned to each survey.,:type:int,:kind:discrete
73+
SurveyStatus,Specifies whether the survey is ongoing or completed.,:type:string,":kind:categorical,:kind:summary"
74+
SurveyType,"The survey type determines whether the survey was a DHS, AIS, MIS, SPA, RHS or other type of survey.",:type:string,":kind:categorical,:kind:summary"
75+
SurveyYear,The principal year in which the survey was conducted.,:type:int,:kind:quantitative
76+
SurveyYearLabel,"The survey year label provides the range of years in which the fieldwork took place. For example if a survey started in 1998 and finished in 1999, the survey year would be 1998 while the survey year label would provide 1998-99. This information could be used to make the user interface more intuitive and accurate.",:type:string,:kind:discrete
77+
TagID,Numeric ID for the tag.,:type:string,:kind:discrete
78+
TagIds,A list of tag IDs for selecting indicators according to tagged groups. See the tags list for the descriptions associated with each ID.,:type:enum-set,:kind:categorical
79+
TagName,Name of the tag.,:type:string,:kind:discrete
80+
TagOrder,Sort order for the tags.,:type:int,:kind:discrete
81+
TagType,"Tag Type: 0 = Subject groups, 1 = Indicator sets (e.g. MDGs, PEPFAR, UNGASS, UNAIDS, PMI/RBM, MICS, UNESCO)",:type:string,":kind:categorical,:kind:summary"
82+
ThumbnailURL,A thumbnail image of the publication cover.,:type:string:url,:kind:discrete
83+
UNAIDS_countryCode,UNAIDS specific three-letter country code.,:type:string,:kind:discrete
84+
UNICEF_countryCode,UNICEF specific three-letter country code.,:type:string,:kind:discrete
85+
UniverseOfMen,"The universe of men interviewed: All Men, Ever Married Men, or Husbands.",:type:string,":kind:categorical,:kind:summary"
86+
UniverseOfWomen,The universe of women interviewed: All Women or Ever Married Women.,:type:string,":kind:categorical,:kind:summary"
87+
UNSTAT_countryCode,UNSTAT specific three-letter country code.,:type:string,:kind:discrete
88+
UpdateDate,Date specifying when the update occurred.,:type:time-stamp,:kind:quantitative
89+
Value,"The actual value (percentage, rate, number, etc.) of the particular indicator specified. The value can be used to provide statistics to users.",:type:mixed,:kind:quantitative
90+
WHO_countryCode,WHO specific two-letter country code.,:type:string,:kind:discrete

‎src/PHPLib/Descriptor.php

+37-1
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,9 @@ public function PrepareInsert()
316316
* <li><tt>{@link kTOKEN_ENUM_TERM}</tt>: This element will contain the enumerated
317317
* value as a term instance key; if the element is a category, this item will be
318318
* omitted.
319+
* <li><tt>{@link kTOKEN_ENUM_PREFERRED}</tt>: This element will contain the preferred
320+
* enumerated value as a term instance key; if the element is a category, or if the
321+
* current element is valid, this item will be omitted.
319322
* <li><tt>{@link kTOKEN_ENUM_CATEGORY}</tt>: This element will contain the instance
320323
* key of the term that represents a category; if the element is an enumerated
321324
* value, this item will be omitted, if the element is a category this item will
@@ -490,6 +493,9 @@ protected function getNamespaceCollection()
490493
* <li><tt>{@link kTOKEN_ENUM_TERM}</tt>: This element will contain the enumerated
491494
* value as a term instance key; if the element is a category, this item will be
492495
* omitted.
496+
* <li><tt>{@link kTOKEN_ENUM_PREFERRED}</tt>: This element will contain the preferred
497+
* enumerated value as a term instance key; if the element is a category, or if the
498+
* current element is valid, this item will be omitted.
493499
* <li><tt>{@link kTOKEN_ENUM_CATEGORY}</tt>: This element will contain the instance
494500
* key of the term that represents a category; if the element is an enumerated
495501
* value, this item will be omitted, if the element is a category this item will
@@ -517,6 +523,11 @@ protected function getEnumeratedList( Collection $theGraph,
517523
kTOKEN_OPT_DIRECTION => kTOKEN_OPT_DIRECTION_IN ] );
518524
if( count( $edges ) )
519525
{
526+
//
527+
// Init preferred.
528+
//
529+
$preferred = NULL;
530+
520531
//
521532
// Iterate edges.
522533
//
@@ -590,7 +601,7 @@ protected function getEnumeratedList( Collection $theGraph,
590601
$this->mCollection->FindByHandle(
591602
$vertex_handle,
592603
[ kTOKEN_OPT_MANY => FALSE,
593-
kTOKEN_OPT_FORMAT => kTOKEN_OPT_FORMAT_DOCUMENT ] );
604+
kTOKEN_OPT_FORMAT => kTOKEN_OPT_FORMAT_DOCUMENT ] );
594605
if( $vertex === NULL )
595606
throw new \RuntimeException (
596607
"Unresolved document handle." ); // !@! ==>
@@ -612,10 +623,35 @@ protected function getEnumeratedList( Collection $theGraph,
612623

613624
break;
614625

626+
//
627+
// Set preferred.
628+
//
629+
case kPREDICATE_PREFERRED:
630+
// Get vertex.
631+
$vertex =
632+
$this->mCollection->FindByHandle(
633+
$vertex_handle,
634+
[ kTOKEN_OPT_MANY => FALSE,
635+
kTOKEN_OPT_FORMAT => kTOKEN_OPT_FORMAT_DOCUMENT ] );
636+
if( $vertex === NULL )
637+
throw new \RuntimeException (
638+
"Unresolved document handle." ); // !@! ==>
639+
640+
// Load preferred.
641+
$preferred = $vertex[ $vertex->Collection()->KeyOffset() ];
642+
643+
break;
644+
615645
} // Parsing by predicate.
616646

617647
} // Iterating found edges.
618648

649+
//
650+
// Set preferred.
651+
//
652+
if( $preferred !== NULL )
653+
$element[ kTOKEN_ENUM_PREFERRED ] = $preferred;
654+
619655
} // Found edges.
620656

621657
} // getEnumeratedList.

‎src/PHPLib/Document.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ class Document extends Container
175175
* Derived classes should first call their parent constructor.
176176
*
177177
* @param Collection $theCollection Collection name.
178-
* @param array $theData Document data.
178+
* @param mixed $theData Document data.
179179
*/
180180
public function __construct( Collection $theCollection, array $theData = [] )
181181
{

0 commit comments

Comments
 (0)