From 1d6f54682059c2905c05c32ed39a94d372b7fa3a Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Mon, 7 Feb 2022 18:36:48 +0500 Subject: [PATCH 01/79] fix issue with variable location fields not exported correctly to DDI/XML --- .../catalog-admin/variable-schema.json | 12 +++-- application/language/base/ddi_fields_lang.php | 5 +- .../language/english/ddi_fields_lang.php | 5 +- application/libraries/DDI_Writer.php | 38 +++++++++------ application/models/Variable_model.php | 46 ++++++++++++++++--- application/schemas/variable-schema.json | 12 +++-- .../views/survey_info/variable_ddi.php | 2 +- 7 files changed, 88 insertions(+), 32 deletions(-) diff --git a/api-documentation/catalog-admin/variable-schema.json b/api-documentation/catalog-admin/variable-schema.json index 7ef70cedc..7c16ff79e 100644 --- a/api-documentation/catalog-admin/variable-schema.json +++ b/api-documentation/catalog-admin/variable-schema.json @@ -39,18 +39,22 @@ "description": "indicates whether the variable is a weight", "default": 0 }, - "var_start_pos": { + "loc_start_pos": { "type": "integer", "title": "Variable start position" }, - "var_end_pos": { + "loc_end_pos": { "type": "integer", "title": "Variable end position" }, - "var_width": { + "loc_width": { "type": "integer", "title": "Variable width" }, + "loc_rec_seg_no": { + "type": "integer", + "title": "Record segment number, deck or card number the variable is located on" + }, "var_imputation": { "type": "string", "title": "Imputation" @@ -204,4 +208,4 @@ } }, "required": [ "vid", "file_id", "name","labl" ] -} \ No newline at end of file +} diff --git a/application/language/base/ddi_fields_lang.php b/application/language/base/ddi_fields_lang.php index 2c68c8316..b5990c92e 100644 --- a/application/language/base/ddi_fields_lang.php +++ b/application/language/base/ddi_fields_lang.php @@ -323,4 +323,7 @@ $lang['contacts']='Contacts'; $lang['others']='Others'; -$lang['producer']='Producer'; \ No newline at end of file +$lang['producer']='Producer'; + +$lang['loc_start_pos']='Start'; +$lang['loc_end_pos']='End'; \ No newline at end of file diff --git a/application/language/english/ddi_fields_lang.php b/application/language/english/ddi_fields_lang.php index 54b4aa0f8..f9e5d659d 100644 --- a/application/language/english/ddi_fields_lang.php +++ b/application/language/english/ddi_fields_lang.php @@ -322,4 +322,7 @@ $lang['contacts']='Contacts'; $lang['others']='Others'; -$lang['producer']='Producer'; \ No newline at end of file +$lang['producer']='Producer'; + +$lang['loc_start_pos']='Start'; +$lang['loc_end_pos']='End'; \ No newline at end of file diff --git a/application/libraries/DDI_Writer.php b/application/libraries/DDI_Writer.php index e3cceeb60..8d314df1f 100644 --- a/application/libraries/DDI_Writer.php +++ b/application/libraries/DDI_Writer.php @@ -308,31 +308,39 @@ function get_var_desc_xml($data) 'dcml'=>$var['var_dcml'], 'intrvl'=>$var['var_intrvl'], ], - 'location._attributes'=>[ - 'StartPos'=>$var['var_start_pos'], - 'EndPos'=>$var['var_end_pos'], - 'width'=>$var['var_width'], - //'RecSegNo'=>$var[''], - ], - 'labl'=>$var['labl'], - 'imputation'=>$var['labl'], - 'security'=>$var['labl'], - 'embargo'=>$var['labl'], - 'respUnit'=>$var['labl'], + 'varFormat'=>[ + '_value'=> (string)$var['var_format.value'], + '_attributes'=>[ + 'type'=>$var['var_format.type'], + //'schema'=>$var['var_format.schema'],//not supported + 'formatname'=>$var['var_format.name'] + ] + ], + + 'location'=>[ + '_attributes'=>[ + 'StartPos'=>$var['loc_start_pos'], + 'EndPos'=>$var['loc_end_pos'], + 'width'=>$var['loc_width'], + 'RecSegNo'=>$var['loc_rec_seg_no'], + ] + ], + + 'labl'=>$var['labl'], + 'imputation'=>$var['var_imputation'], + 'security'=>$var['var_security'], + 'respUnit'=>$var['var_respunit'], 'qstn.preQTxt'=>$var['var_qstn_preqtxt'], 'qstn.qstnLit'=>$var['var_qstn_qstnlit'], 'qstn.postQTxt'=>$var['var_qstn_postqtxt'], 'qstn.ivuInstr'=>$var['var_qstn_ivulnstr'], //'valrng'=>$var[''],//repeatable field - not supported - 'universe'=>$var['var_universe'], - + 'universe'=>$var['var_universe'], 'sumStat'=> [], //repeatable - 'catgry'=>[], - 'notes'=>$var['var_notes'], 'txt'=>$var['var_txt'], 'codInstr'=>$var['var_codinstr'], diff --git a/application/models/Variable_model.php b/application/models/Variable_model.php index 50a19c46f..b97b5e883 100644 --- a/application/models/Variable_model.php +++ b/application/models/Variable_model.php @@ -31,8 +31,9 @@ function select_single($vid) $this->db->where("uid",$vid); $variable=$this->db->get("variables")->row_array(); - if(isset($variable['metadata'])){ + if(isset($variable['metadata'])){ $variable['metadata']=$this->Dataset_model->decode_metadata($variable['metadata']); + $variable=$this->map_variable_fields($variable); } return $variable; @@ -50,8 +51,9 @@ function select_all($sid) $this->db->where("sid",$sid); $variables=$this->db->get("variables")->result_array(); - foreach($variables as $key=>$variable){ + foreach($variables as $key=>$variable){ $variables[$key]['metadata']=$this->Dataset_model->decode_metadata($variable['metadata']); + $variable=$this->map_variable_fields($variable); } return $variables; @@ -99,8 +101,9 @@ function chunk_read($sid,$start_uid=0, $limit=100) $variables=$this->db->get("variables")->result_array(); - foreach($variables as $key=>$variable){ + foreach($variables as $key=>$variable){ $variables[$key]['metadata']=$this->Dataset_model->decode_metadata($variable['metadata']); + $variable=$this->map_variable_fields($variable); } return $variables; @@ -120,8 +123,9 @@ function get_var_by_vid($sid,$vid) $variable=$this->db->get("variables")->row_array(); - if(isset($variable['metadata'])){ + if(isset($variable['metadata'])){ $variable['metadata']=$this->Dataset_model->decode_metadata($variable['metadata']); + $variable=$this->map_variable_fields($variable); } return $variable; @@ -141,8 +145,9 @@ function get_var_by_uid($sid,$uid) $variable=$this->db->get("variables")->row_array(); - if(isset($variable['metadata'])){ + if(isset($variable['metadata'])){ $variable['metadata']=$this->Dataset_model->decode_metadata($variable['metadata']); + $variable=$this->map_variable_fields($variable); } return $variable; @@ -162,8 +167,9 @@ function get_by_var_id($sid, $file_id=null, $var_id) $variable=$this->db->get("variables")->row_array(); - if(isset($variable['metadata'])){ + if(isset($variable['metadata'])){ $variable['metadata']=$this->Dataset_model->decode_metadata($variable['metadata']); + $variable=$this->map_variable_fields($variable); } return $variable; @@ -189,6 +195,7 @@ function get_batch_variable_metadata($sid, $file_id=null, $vid_arr=array()) foreach($variables as $idx=>$variable){ if(isset($variable['metadata'])){ $variables[$idx]['metadata']=$this->Dataset_model->decode_metadata($variable['metadata']); + $variables[$idx]=$this->map_variable_fields($variables[$idx]); } } @@ -369,6 +376,7 @@ public function insert($sid,$options) //metadata if(isset($options['metadata'])){ + $options=$this->map_variable_fields($options); $options['metadata']=$this->Dataset_model->encode_metadata($options['metadata']); } @@ -400,6 +408,7 @@ public function update($sid,$uid,$options) //metadata if(isset($options['metadata'])){ + $options=$this->map_variable_fields($options); $options['metadata']=$this->Dataset_model->encode_metadata($options['metadata']); } @@ -430,6 +439,7 @@ public function batch_insert($sid,$variables) $variables[$key]=array_intersect_key($variable,array_flip($valid_fields)); $variables[$key]['sid']=$sid; if(isset($variable['metadata'])){ + $variable=$this->map_variable_fields($variable); $variables[$key]['metadata']=$this->Dataset_model->encode_metadata($variable['metadata']); } } @@ -565,6 +575,30 @@ function variable_basic_info($sid,$vid) $variable=$this->db->get("variables")->row_array(); return $variable; } + + /** + * + * Fix for inconsistent variable schema fields + */ + function map_variable_fields($variable) + { + $mappings=array( + 'var_start_pos'=>'loc_start_pos', + 'var_end_pos'=>'loc_end_pos', + 'var_width'=>'loc_width', + 'var_rec_seg_no'=>'loc_rec_seg_no', + ); + + foreach($variable['metadata'] as $key=>$value){ + //complex types e.g. repeatable array types + if(array_key_exists($key,$mappings)){ + $variable['metadata'][$mappings[$key]]=$value; + unset($variable['metadata'][$key]); + } + } + + return $variable; + } } diff --git a/application/schemas/variable-schema.json b/application/schemas/variable-schema.json index 7ef70cedc..cc34ef167 100644 --- a/application/schemas/variable-schema.json +++ b/application/schemas/variable-schema.json @@ -39,18 +39,22 @@ "description": "indicates whether the variable is a weight", "default": 0 }, - "var_start_pos": { + "loc_start_pos": { "type": "integer", "title": "Variable start position" }, - "var_end_pos": { + "loc_end_pos": { "type": "integer", "title": "Variable end position" }, - "var_width": { + "loc_width": { "type": "integer", "title": "Variable width" }, + "loc_rec_seg_no": { + "type": "integer", + "title": "Record segment number, deck or card number the variable is located on" + }, "var_imputation": { "type": "string", "title": "Imputation" @@ -203,5 +207,5 @@ "title": "Variable notes" } }, - "required": [ "vid", "file_id", "name","labl" ] + "required": [ "vid", "file_id", "name","labl" ] } \ No newline at end of file diff --git a/application/views/survey_info/variable_ddi.php b/application/views/survey_info/variable_ddi.php index e92edc291..b23ba068e 100644 --- a/application/views/survey_info/variable_ddi.php +++ b/application/views/survey_info/variable_ddi.php @@ -61,7 +61,7 @@
From 64ecad0146730525af94eda8294e5be75f832e67 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Tue, 8 Feb 2022 12:42:30 +0500 Subject: [PATCH 02/79] Add search filter for regions --- .../libraries/Catalog_search_mysql.php | 46 ++++++++++- application/models/Facet_model.php | 2 +- application/models/Search_helper_model.php | 76 +++++++++++++++++++ .../views/search/active_filter_tokens.php | 8 ++ 4 files changed, 128 insertions(+), 4 deletions(-) diff --git a/application/libraries/Catalog_search_mysql.php b/application/libraries/Catalog_search_mysql.php index f27e1050a..e6c91f07a 100644 --- a/application/libraries/Catalog_search_mysql.php +++ b/application/libraries/Catalog_search_mysql.php @@ -21,6 +21,7 @@ class Catalog_search_mysql{ var $topics=array(); var $tags=array(); var $countries=array(); + var $regions=array(); var $from=0; var $to=0; var $repo=''; @@ -107,6 +108,7 @@ public function search($limit=15, $offset=0) $variable=false;//$this->_build_variable_query(); $topics=$this->_build_topics_query(); $countries=$this->_build_countries_query(); + $regions=$this->_build_regions_query(); $tags=$this->_build_tags_query(); $collections=$this->_build_collections_query(); $years=$this->_build_years_query(); @@ -159,7 +161,7 @@ public function search($limit=15, $offset=0) } //array of all options - $where_list=array($study,$variable,$topics,$countries,$years,$repository,$collections,$dtype,$sid,$countries_iso3,$created,$data_classification,$tags,$type); + $where_list=array($study,$variable,$topics,$countries,$years,$repository,$collections,$dtype,$sid,$countries_iso3,$created,$data_classification,$tags,$type,$regions); foreach($this->user_facets as $fc){ if (array_key_exists($fc['name'],$this->params)){ @@ -331,6 +333,7 @@ public function search_counts_by_type() $variable=false;//$this->_build_variable_query(); $topics=$this->_build_topics_query(); $countries=$this->_build_countries_query(); + $regions=$this->_build_regions_query(); $tags=$this->_build_tags_query(); $collections=$this->_build_collections_query(); $years=$this->_build_years_query(); @@ -341,7 +344,7 @@ public function search_counts_by_type() $countries_iso3=$this->_build_countries_iso3_query(); //array of all options - $where_list=array($tags,$study,$variable,$topics,$countries,$years,$repository,$collections,$dtype,$data_classification,$sid,$countries_iso3); + $where_list=array($tags,$study,$variable,$topics,$countries,$years,$repository,$collections,$dtype,$data_classification,$sid,$countries_iso3,$regions); foreach($this->user_facets as $fc){ if (array_key_exists($fc['name'],$this->params)){ @@ -739,6 +742,42 @@ protected function _build_countries_query() } + /** + * + * build where for regions + */ + protected function _build_regions_query() + { + $regions=$this->regions;//must always be an array + + if (!is_array($regions)){ + return FALSE; + } + + if ( !count($regions)>0){ + return false; + } + + foreach($regions as $idx=>$region){ + if(!is_numeric($region)){ + unset($regions[$idx]); + } + } + + $regions= implode(',',$regions); + + if ($regions!=''){ + //return sprintf('surveys.id in (select sid from survey_countries where cid in (%s))',$regions); + + return sprintf('surveys.id in (select sid from region_countries + inner join survey_countries on region_countries.country_id=survey_countries.cid + where region_countries.region_id in (%s))',$regions); + } + + return FALSE; + } + + /** * * build where countries by iso3 code @@ -1038,6 +1077,7 @@ public function vsearch($limit = 15, $offset = 0) $variable=$this->_build_variable_query(); $topics=$this->_build_topics_query(); $countries=$this->_build_countries_query(); + $regions=$this->_build_regions_query(); $years=$this->_build_years_query(); $collections=$this->_build_collections_query(); $dtype=$this->_build_dtype_query(); @@ -1045,7 +1085,7 @@ public function vsearch($limit = 15, $offset = 0) $repository=$this->_build_repository_query(); //array of all options - $where_list=array($study,$variable,$topics,$countries,$years,$collections,$dtype,$tags,$repository); + $where_list=array($study,$variable,$topics,$countries,$years,$collections,$dtype,$tags,$repository,$regions); //show only publshed studies $where_list[]='published=1'; diff --git a/application/models/Facet_model.php b/application/models/Facet_model.php index dad62915e..0b1ec16be 100644 --- a/application/models/Facet_model.php +++ b/application/models/Facet_model.php @@ -23,7 +23,7 @@ function get_facet_options() function get_core_facets_list() { - return ['tag','topic','country','year','collection','data_class','dtype','type']; + return ['tag','topic','country','year','collection','data_class','dtype','type','region']; } diff --git a/application/models/Search_helper_model.php b/application/models/Search_helper_model.php index d874d0bdb..4fccce3dc 100644 --- a/application/models/Search_helper_model.php +++ b/application/models/Search_helper_model.php @@ -764,6 +764,31 @@ function get_countries_list($countries) return $output; } + /** + * + * Returns a list of regions + * + * @countries - array of region integer codes + * + */ + function get_regions_list($regions=null) + { + $this->db->select('id,title'); + + if(is_array($regions) && count($regions)>0){ + $this->db->where_in('id',$regions); + } + + $result=$this->db->get('regions')->result_array(); + + $output=array(); + foreach($result as $row){ + $output[$row['id']]=$row['title']; + } + + return $output; + } + /** * @@ -796,5 +821,56 @@ function related_collections($sid_arr) return $output; } + + public function get_active_regions($repositoryid=NULL, $study_type=NULL,$filter_values=array()) + { + //parent regions + $this->db->select('parent_regions.title as group_name,regions.id,regions.title,regions.weight,count(distinct surveys.id) as found'); + $this->db->join('regions', 'parent_regions.id= regions.pid','INNER'); + + $this->db->join('region_countries', 'region_countries.region_id=regions.id','INNER'); + $this->db->join('countries', 'countries.countryid=region_countries.country_id','INNER'); + $this->db->join('survey_countries', 'survey_countries.cid=countries.countryid','INNER'); + $this->db->join('surveys', 'surveys.id=survey_countries.sid','INNER'); + + $this->db->order_by('parent_regions.id,regions.weight'); + $this->db->group_by('parent_regions.title, regions.id, regions.title, regions.weight'); + $this->db->where('surveys.published',1); + + //filter by repository + if (trim($repositoryid)!=='' && $repositoryid!='central') + { + $subquery= sprintf('(surveys.repositoryid= %s OR sr.repositoryid = %s)', + $this->db->escape($repositoryid), + $this->db->escape($repositoryid)); + + $this->db->join('survey_repos sr', 'sr.sid=surveys.id','inner'); + $this->db->where($subquery,null,false); + } + + if($study_type!=NULL){ + $this->db->where('surveys.type',$study_type); + if($filter_values!=NULL){ + $this->db->or_where_in('regions.id',$filter_values); + } + } + + $query=$this->db->get('regions as parent_regions'); + + if (!$query){ + return FALSE; + } + + $rows=$query->result_array(); + + $regions=array(); + foreach($rows as $row) + { + $regions[$row['id']]=$row; + } + + return $regions; + } + }//end class diff --git a/application/views/search/active_filter_tokens.php b/application/views/search/active_filter_tokens.php index c035d5611..556663a3b 100644 --- a/application/views/search/active_filter_tokens.php +++ b/application/views/search/active_filter_tokens.php @@ -79,6 +79,14 @@ class="badge badge-default badge-secondary wb-badge-close remove-filter type" + region) && is_array($search_options->region)):?> + region as $region):?> + + + + + + dtype) && is_array($search_options->dtype)):?> dtype as $dtype):?> From 673c28a9202eb7c4a46baedb683bceaaecdcdd84 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Tue, 8 Feb 2022 12:46:07 +0500 Subject: [PATCH 03/79] update Arabic translations --- .../language/arabic/breadcrumbs_lang.php | 16 +- .../language/arabic/catalog_admin_lang.php | 201 +++++++++-- .../language/arabic/catalog_search_lang.php | 284 +++++++++++----- .../language/arabic/citations_lang.php | 126 +++---- .../language/arabic/collection_lang.php | 53 +++ .../language/arabic/configurations_lang.php | 97 +++--- .../language/arabic/da_collection_lang.php | 19 ++ .../language/arabic/dashboard_lang.php | 58 ++-- .../language/arabic/data_enclave_lang.php | 25 +- application/language/arabic/dd_help_lang.php | 267 +++++++++++++++ .../language/arabic/dd_projects_lang.php | 171 ++++++++++ .../language/arabic/ddi_fields_lang.php | 311 ++++++++++++++++++ .../language/arabic/ddibrowser_lang.php | 185 +++++++---- .../arabic/direct_access_terms_lang.php | 56 ++-- .../language/arabic/ecatalog_admin_lang.php | 86 ++--- .../language/arabic/fields_document_lang.php | 161 +++++++++ .../language/arabic/fields_image_lang.php | 169 ++++++++++ .../language/arabic/fields_scripts_lang.php | 179 ++++++++++ .../language/arabic/fields_table_lang.php | 145 ++++++++ .../arabic/fields_timeseries_lang.php | 113 +++++++ .../arabic/fields_timeseriesdb_lang.php | 97 ++++++ .../language/arabic/fields_video_lang.php | 15 + .../arabic/fields_visualization_lang.php | 160 +++++++++ application/language/arabic/general_lang.php | 102 ++++-- .../language/arabic/harvester_lang.php | 44 +-- application/language/arabic/install_lang.php | 82 +++-- .../language/arabic/iso19139_fields_lang.php | 78 +++++ .../arabic/licensed_access_form_lang.php | 196 +++++------ .../language/arabic/licensed_request_lang.php | 125 ++++--- application/language/arabic/menu_lang.php | 18 +- .../language/arabic/open_data_lang.php | 17 + .../language/arabic/permissions_lang.php | 23 ++ .../arabic/public_access_terms_lang.php | 87 ++--- .../language/arabic/public_request_lang.php | 33 +- application/language/arabic/reports_lang.php | 90 +++-- .../language/arabic/resource_manager_lang.php | 164 ++++----- .../language/arabic/rest_controller_lang.php | 17 + .../language/arabic/search_help_lang.php | 66 ++++ .../language/arabic/site_menu_lang.php | 31 ++ application/language/arabic/sitelogs_lang.php | 17 +- .../language/arabic/user_groups_lang.php | 24 ++ .../language/arabic/users_additional_lang.php | 54 +-- application/language/arabic/users_lang.php | 97 +++--- .../language/arabic/vocabularies_lang.php | 14 +- 44 files changed, 3453 insertions(+), 920 deletions(-) create mode 100644 application/language/arabic/collection_lang.php create mode 100644 application/language/arabic/da_collection_lang.php create mode 100644 application/language/arabic/dd_help_lang.php create mode 100644 application/language/arabic/dd_projects_lang.php create mode 100644 application/language/arabic/ddi_fields_lang.php create mode 100644 application/language/arabic/fields_document_lang.php create mode 100644 application/language/arabic/fields_image_lang.php create mode 100644 application/language/arabic/fields_scripts_lang.php create mode 100644 application/language/arabic/fields_table_lang.php create mode 100644 application/language/arabic/fields_timeseries_lang.php create mode 100644 application/language/arabic/fields_timeseriesdb_lang.php create mode 100644 application/language/arabic/fields_video_lang.php create mode 100644 application/language/arabic/fields_visualization_lang.php create mode 100644 application/language/arabic/iso19139_fields_lang.php create mode 100644 application/language/arabic/open_data_lang.php create mode 100644 application/language/arabic/permissions_lang.php create mode 100644 application/language/arabic/rest_controller_lang.php create mode 100644 application/language/arabic/search_help_lang.php create mode 100644 application/language/arabic/site_menu_lang.php create mode 100644 application/language/arabic/user_groups_lang.php diff --git a/application/language/arabic/breadcrumbs_lang.php b/application/language/arabic/breadcrumbs_lang.php index b15c72de1..7ab4f1408 100644 --- a/application/language/arabic/breadcrumbs_lang.php +++ b/application/language/arabic/breadcrumbs_lang.php @@ -1,7 +1,17 @@ الربط أو إلغاء الارتباط لربط الدراسات أو إلغاء ربطها."; +$lang['copy_studies_to']="نسخ الدراسات إلى"; +$lang['change_repo']="تحويل"; +$lang['repositoryid']="مجموعة"; +$lang['copy_studies']="نسخ الدراسات"; +$lang['transfer_study_ownership']="نقل مالك الدراسة"; +$lang['transfer_ownership']="نقل المالك"; +$lang['msg_studies_to_transfer']="الدراسات التي سيتم نقلها"; +$lang['study_owned']="الدراسة المملوكة"; +$lang['study_linked']="الدراسة المربوطة"; +$lang['is_harvested_study']="الدراسة المحصودة"; +$lang['select_publish_unpublish']="حدد للنشر / إلغاء النشر"; +$lang['publish']="نشر"; +$lang['series']="سلسلة"; +$lang['data_access']="النفاذ للبيانات"; +$lang['overwrite_if_exists']="إستبدل إن وجدت؟"; +$lang['sort_by']="ترتيب النتائج حسب:"; +$lang['surveyid']="رقم المسح"; +$lang['no_related_citations_click_here_to_add']="لا توجد اقتباسات مرفقة بهذا المسح، لإضافة الاقتباسات ذات الصلة ، انقر هنا."; +$lang['max_upload_limit']="أقصى حجم لملف التحميل:"; +$lang['upload_ddi']="أضف دراسة"; +$lang['clear_filter']="مسح التصفية/الفلتر"; +$lang['countries']="البلدان"; +$lang['titl']="العنوان"; +$lang['study_status']="حالة الدراسة"; +$lang['all']="الكل"; +$lang['published']="منشورة"; +$lang['unpublished']="غير منشورة"; +$lang['tags']="العلامات Tags"; +$lang['click_to_publish_unpublish']="انقر للنشر أو إلغاء النشر"; +$lang['pdf_not_generated']="لم يتم إنشاء ملف PDF"; +$lang['pdf_uptodate']="ملف PDF محدث"; +$lang['pdf_outdated']="ملف PDF قديم"; +$lang['metadata_in_pdf']="البيانات الوصفية في PDF"; +$lang['replace_ddi']="استبدل DDI"; +$lang['delete_study']="حذف الدراسة"; +$lang['generate_pdf']="إنشاء/توليد ملف PDF"; +$lang['upload_rdf']="تحميل RDF"; +$lang['link_resources']="ربط الموارد"; +$lang['export_ddi']="تصدير DDI"; +$lang['export_rdf']="تصدير RDF"; +$lang['admin_notes']="ملاحظات المسؤول"; +$lang['reviewer_notes']="ملاحظات المراجع"; +$lang['study_collections']="عرض في مجموعات أخرى"; +$lang['study_aliases']="الأسماء المستعارة للدراسة"; +$lang['study_warnings']="تحذيرات!"; +$lang['warning_study_has_no_external_resources']="الدراسة ليس لها موارد خارجية مرفقة"; +$lang['warning_study_has_no_microdata']="الدراسة ليس لها بيانات جزئية مرفقة"; +$lang['warning_study_has_no_questionnaire']="الدراسة ليس لديها إستمارات مرفقة"; +$lang['warning_study_has_pending_licensed_requests']="الدراسة لديها طلبات مرخصة في حالة الانتظار"; +$lang['warning_study_not_published']="الدراسة لم تنشر"; +$lang['warning_study_years_not_set']="الدراسة لم يتم تعيين سنوات جمع البيانات لها "; +$lang['warning_study_has_no_pdf_documentation']="الدراسة لم يتم انشاء توثيق البيانات الوصفية لها في ملف PDF"; +$lang['study_no_questionnaire']="دراسات بدون إستمارات"; +$lang['study_no_datafile']="دراسات بدون بيانات"; +$lang['filter']="فلترة/تصفية"; +$lang['ID']="الرقم/المعرّف"; +$lang['collection']="مجموعة"; +$lang['modified_on']="تعديل بتاريخ"; +$lang['Published']="منشورة"; +$lang['Survey options']="خيارات المسح"; +$lang['Tags']="علامات Tags"; +$lang['Generate PDF']="إنشاء/توليد PDF"; +$lang['Status']="حالة"; +$lang['batch_upload_files']="تحميل ملفات"; +$lang['clear_import_folder']="إمسح ملفات الاستيراد"; +$lang['central_catalog_short_text']="فقرة تصف الكتالوج المركزي"; +$lang['study_exists_in_other_collection']="الدراسة موجودة بالفعل في المجموعة [s%]. لتحديث الدراسة ، يجب عليك التبديل إلى المجموعة وتحميل DDI."; +$lang['type_admin']="ملاحظات المسؤول"; +$lang['type_reviewer']="ملاحظات المراجع"; +$lang['type_public']="ملاحظات عامة"; +$lang['select_note_type']="حدد نوع الملاحظة"; +$lang['admin_note']="ملاحظة المسؤول"; +$lang['reviewer_note']="ملاحظة المراجع"; +$lang['public_note']="ملاحظة عامة"; +$lang['add_note']="أضف ملاحظة"; +$lang['click_on_icon_to_remove_citation']="انقر فوق الرمز s% لإزالة الاقتباس"; +$lang['attach_citation']="إرفاق الاقتباس"; +$lang['js_refreshing_page']="جاري تحميل الصفحة ، برجاء الانتظار ..."; +$lang['remove_from_collection']="إزالة"; +$lang['remove_from_collection_description']="إزالة هذه الدراسة من هذه المجموعة."; +$lang['studies_linked_count']="دراسات مرتبطة من مجموعات أخرى"; +$lang['notes']="ملاحظات"; +$lang['link_study']="ربط"; +$lang['unlink_study']="إزالة الربط"; +$lang['transfer']="نقل"; +$lang['select_the_repository_from_the_list_below']="حدد المجموعة من القائمة أدناه لنقل الملكية إلى مجموعة أخرى."; +$lang['study_metadata_updated']="تم تحديث البيانات الوصفية للدراسة!"; +$lang['refresh_ddi']="تحديث DDI"; +$lang['batch_refresh_ddi']="تحديث حزمة DDI"; +$lang['ddi_batch_refresh_title']="تحديث حزمة DDI"; +$lang['btn_refresh']="تحديث DDI"; +$lang['refresh_ddi_description']="تحديث DDI تحدث قاعدة البيانات بالبيانات الوصفية من DDI."; +$lang['total_studies_found']="مجموع الدراسات التي وجدت"; +$lang['mark_as_featured']="العرض كدراسة مميزة؟"; +$lang['msg_study_ownership_has_changed']="تغيرت ملكية الدراسة!"; +$lang['replace_ddi_failed_duplicate_study_found']="يحتوي الكتالوج على دراسة أخرى بنفس المعرف"; +$lang['show_selected_only']="إظهار المحدد فقط"; +$lang['Data available from external repository']="البيانات متاحة من مستودع خارجي"; +$lang['Data not available']="البيانات غير متوفرة"; +$lang['error_no_collection_selected']="لم تقم بتحديد المجموعة!"; +$lang['confirm_publish_records']="تأكيد لنشر الدراسة؟"; +$lang['confirm_publish']="ينشر؟"; +$lang['attach_citations']="إرفاق الإقتباسات"; +$lang['return_to_edit_page']="العودة لتحرير الصفحة"; +$lang['attach_related_data']="إرفاق ذات الصلة"; +$lang['no_related_studies_click_here_to_add']="لا توجد دراسات ذات صلة مرفقة"; +$lang['relationship_type']="نوع العلاقة"; +$lang['draft']="مسودة"; +$lang['confirm_unpublish_records']="هل أنت متأكد أنك تريد إلغاء نشر السجلات؟"; +$lang['confirm_unpublish']="تأكيد إلغاء النشر"; +$lang['idno']="رقم/معرّف الدراسة"; +$lang['search_results_for']="نتائج البحث عن:"; +$lang['tab_overview']="نبذة"; +$lang['tab_manage_files']="ملفات"; +$lang['tab_resources']="موارد"; +$lang['tab_citations']="اقتباسات"; +$lang['tab_data_files']="ملفات البيانات"; +$lang['tab_notes']="ملاحظات"; +$lang['tab_related_data']="دراسات ذات صلة"; +$lang['license']="رخصة"; +$lang['select_license']="إختر الرخصة"; +$lang['select_study_thumbnail']="إختر ملف الصورة (PNG ، JPG ، JPEG ، GIF)"; +$lang['Thumbnal']="الصورة المصغرة"; +$lang['Upload thumbnal']="تحميل الصورة المصغرة"; + + +/* End of file catalog_admin */ +/* Location: ./application/language/arabic/catalog_admin */ \ No newline at end of file diff --git a/application/language/arabic/catalog_search_lang.php b/application/language/arabic/catalog_search_lang.php index 053567a5f..635dd9ae7 100644 --- a/application/language/arabic/catalog_search_lang.php +++ b/application/language/arabic/catalog_search_lang.php @@ -1,114 +1,250 @@ %d من %d-%d عرض "; -$lang['found_study']="%dمسح من %dوجود"; -$lang['found_studies']="%dمسوح من %dوجود "; -$lang['showing_variables']="متغيرات%d من%d-%dعرض "; -$lang['showing_pages']="%dمن %s صفحة "; -$lang['variables_keywords_found']=" d% تم العثور على كلمات البحث في d% متغير من أصل"; -$lang['link_browse_metadata']="تصفح البيانات الوصفية"; -$lang['link_browse_metadata_hover']="تصفح البيانات الوصفية"; -$lang['link_access_policy']="سياسة النفاذ"; +$lang['showing_studies']="إظهار %d-%d من%d"; +$lang['found_study']="تم العثور على %d دراسة من أصل %d"; +$lang['found_studies']="تم العثور على % d دراسات من إجمالي % d "; +$lang['found_variable']="تم العثور على % d متغير من أصل % d "; +$lang['found_variables']="تم العثور على % d متغيرات من أصل % d "; +$lang['showing_variables']="إظهار %d-%d من % s المتغيرات"; +$lang['showing_pages']=" الصفحة d% من s% +"; +$lang['variables_keywords_found']="تم العثور على كلمة (كلمات) رئيسية في d% متغير (متغيرات) من d% "; +$lang['link_browse_metadata']="إستعراض البيانات الوصفية"; +$lang['link_browse_metadata_hover']="إستعراض البيانات الوصفية"; +$lang['link_access_policy']="سياسة النفاذ/الوصول"; $lang['link_access_policy_hover']="سياسة النفاذ الى البيانات االجزئية"; $lang['link_data']="بيانات"; -$lang['link_data_direct_hover']="استمارة طلب البيانات الجزئية (نفاذ مباشر)"; -$lang['link_data_public_hover']="استمارة طلب البيانات الجزئية (نفاذ للعموم) "; -$lang['link_data_licensed_hover']="استمارة طلب البيانات الجزئية (نفاذ مرخص) "; -$lang['link_data_enclave_hover']="استمارة طلب البيانات الجزئية (في المركز)"; -$lang['link_citations']="وصلة الاقتباس"; +$lang['link_data_direct_hover']="نموذح طلب البيانات الجزئية (نفاذ مباشر)"; +$lang['link_data_public_hover']="نموذج طلب البيانات الجزئية (نفاذ للعموم) "; +$lang['link_data_licensed_hover']="نموذج طلب البيانات الجزئية (نفاذ مرخص) "; +$lang['link_data_enclave_hover']="نموذج طلب البيانات الجزئية (في المركز)"; +$lang['link_citations']="الإقتباس"; $lang['link_citations_hover']="الدراسات ذات الصلة بالاقتباسات"; -$lang['link_reports']="التقارير و المخرجات التحليلية"; -$lang['link_reports_hover']="التقارير و المخرجات التحليلية"; -$lang['link_indicators']="المؤشرات و الجداول (قاعدة البيانات)"; -$lang['link_indicators_hover']="المؤشرات و الجداول (قاعدة البيانات)"; +$lang['link_reports']="التقارير والمخرجات التحليلية"; +$lang['link_reports_hover']="التقارير والمخرجات التحليلية"; +$lang['link_indicators']="أدوات تفاعلية"; +$lang['link_indicators_hover']="أدوات تفاعلية"; $lang['link_questionnaires']="الاستمارات"; $lang['link_questionnaires_hover']="الاستمارات"; $lang['link_technical']="الوثائق التقنية"; $lang['link_technical_hover']="الوثائق التقنية"; -$lang['link_study_website']="موقع الدراسة"; -$lang['link_study_website_hover']="موقع الدراسة(مع كل الوثائق المتاحة) "; -$lang['link_ddi']=" (DDI)البيانات الوصفية للمسح"; -$lang['link_ddi_hover']=" DDIالبيانات الوصفية للمسح بصيغة "; -$lang['switch_to_study_view']="تبديل الى عرض المسوح"; +$lang['link_study_website']="الموقع الإلكترني للدراسة"; +$lang['link_study_website_hover']="الموقع الإلكترني للدراسة (مع كل الوثائق المتاحة) "; +$lang['link_ddi']=" البيانات الوصفية للدراسة (DDI)"; +$lang['link_ddi_hover']=" البيانات الوصفية للمسح بصيغة DDI "; +$lang['switch_to_study_view']="تبديل الى عرض الدراسة"; $lang['compare_hover']="مقارنة المتغيرات"; $lang['compare_selected_variables']="مقارنة المتغيرات المختارة"; $lang['mark_for_variable_comparison']="تعيين المتغير للمقارنة"; -$lang['variable_info']="معلومات على المتغيرات"; -$lang['field_survey_title']="اسم المسح"; -$lang['js_searching']="...جاري البحث الرجاء الانتظار"; -$lang['js_loading']="...جاري التحميل الرجاء الانتظار"; +$lang['variable_info']="معلومات المتغير"; +$lang['field_survey_title']="عنوان المسح"; +$lang['js_searching']="جاري البحث الرجاء الانتظار ..."; +$lang['js_loading']="جاري التحميل الرجاء الانتظار ..."; $lang['js_invalid_year_range_selected']="مجموعة السنوات المختارة غير صالحة."; -$lang['js_topic_selected']="المواضيع المختارة"; +$lang['js_topic_selected']="الموضوع المختار"; $lang['js_topics_selected']="المواضيع المختارة"; -$lang['js_country_selected']="البلدان المختارة"; +$lang['js_country_selected']="البلد المختارة"; $lang['js_countries_selected']="البلدان المختارة"; -$lang['title_compare_variables']="مقارنة المتغيرات المختارة"; +$lang['title_compare_variables']="مقارنة المتغيرات "; $lang['click_drag_move']="انقر واسحب للنقل"; -$lang['open_in_new_window']="افتح صفحة جديدة"; -$lang['download_pdf']=" PDFتنزيل"; -$lang['click_to_browse_metadata']="انقر هنا لتصفح البيانات الوصفية"; -$lang['producers']="المنتجين"; -$lang['sponsors']="الممولين"; -$lang['citations_of_publications']="الاستشهادات والمنشورات التي استعملت الدراسة"; -$lang['study_resources']="وثائق الدراسة"; +$lang['open_in_new_window']="افتح في صفحة جديدة"; +$lang['download_pdf']=" تنزيل PDF"; +$lang['download_csv']="تنزيل ملف CSV"; +$lang['download_json']="تنزيل ملف JSON"; +$lang['click_to_browse_metadata']="انقر هنا لإستعراض البيانات الوصفية"; +$lang['producers']="المنتجون"; +$lang['sponsors']="الممولون"; +$lang['citations_of_publications']="المنشورات ذات الصلة"; $lang['click_to_view_information']="انقر لعرض المعلومات"; -$lang['view_more_information']="عرض معلومات اكثر"; +$lang['view_more_information']="عرض المزيد من المعلومات"; $lang['technical_documents']="وثائق تقنية"; $lang['reports']="تقارير"; -$lang['questionnaires']="استبيانات"; -$lang['other_materials']="مواد اخرى"; +$lang['questionnaires']="إستمارات"; +$lang['other_materials']="مواد أخرى"; $lang['description']="وصف"; -$lang['abstract']="خلاصة"; +$lang['abstract']="ملخص"; $lang['table_of_contents']="جدول المحتويات"; $lang['classification']="تصنيف"; $lang['compare_hover_text']="مقارنة المتغيرات المختارة"; -$lang['select_number_of_records_per_page']="اختر عدد من السجلات في كل صفحة"; -$lang['source_catalog']=" s%البيانات الوصفية يوفرها"; -$lang['source']="مورد"; -$lang['download_ddi']="DDIتحميل "; +$lang['select_number_of_records_per_page']="حدد عدد السجلات لإظهارها لكل صفحة"; +$lang['source_catalog']="البيانات الوصفية الموفرة من قبل s%"; +$lang['source']="المصدر"; +$lang['download_ddi']="تنزيل DDI"; $lang['link_data_remote_hover']="البيانات الجزئية المتاحة من مستودع خارجي "; -$lang['collections']="مجموعة"; -$lang['legend_direct_access']="النفاذ المباشر"; -$lang['legend_data_public']="الملفات للاستخدم العام"; -$lang['legend_data_licensed']="ملف بموجب ترخيص"; +$lang['collections']="مجموعات"; +$lang['legend_data_direct']="الوصول المباشر إلى البيانات"; +$lang['legend_data_public']="ملفات البيانات المؤهلة للإستخدام العام"; +$lang['legend_data_licensed']="ملفات بيانات بموجب ترخيص"; $lang['legend_data_enclave']="البيانات الجزئية في المركز"; +$lang['legend_data_open']="الوصول المفتوح للبيانات"; $lang['legend_data_remote']="البيانات المتاحة من خلال مستودع خارجي"; +$lang['legend_data_data_na']="البيانات غير المتوفرة"; +$lang['legend_data_cc40']="رخصة المشاع الإبداعي 4.0"; +$lang['legend_data_research']="بحث البيانات الجزئية"; +$lang['legend_data_research_public']="البيانات الجزئية للبحث العام"; +$lang['legend_data_research_license']="بحث البيانات الجزئية بترخيص"; +$lang['legend_data_research_public_lic']="البيانات الجزئية للأبحاث العامة مع الترخيص"; +$lang['data_class_public']="عام"; +$lang['data_class_official']="رسمي"; +$lang['data_class_confidential']="خصوصي وسري"; +$lang['license']="مرخص"; +$lang['data_class_note_public']="تم تصنيف مجموعة البيانات هذه على أنها عامة بموجب سياسة تصنيف الوصول إلى المعلومات. يمكن للموظفين والمستخدمين الخارجيين الوصول إلى مجموعة البيانات هذه."; +$lang['data_class_note_official']="تم تصنيف مجموعة البيانات هذه على أنها رسمية بموجب سياسة تصنيف الوصول إلى المعلومات. الوصول إلى البيانات يقتصر على الموظفين فقط."; +$lang['data_class_note_confidential']="تم تصنيف مجموعة البيانات هذه على أنها سرية بموجب سياسة تصنيف الوصول إلى المعلومات. الوصول إلى البيانات يقتصر على الموظفين فقط."; $lang['no_variables_to_compare']="لم تقم بتحديد أية متغيرات للمقارنة. الرجاء العودة وتحديد بعض المتغيرات ثم قم بتشغيل المقارنة مرة أخرى"; -$lang['accesspolicy']="سياسة النفاذ"; -$lang['study_meta_description']="يتم سرد %s التي تنتجها %s في كتالوج %s. البيانات والبيانات الوصفية متاحة من الرابط أعلاه."; -$lang['meta_description_catalog']="كتالوج البيانات يمكنك من تصفح وبحث وتحميل و دراسة البيانات و البيانات الوصفية . +$lang['refno']="الرقم المرجعي"; +$lang['accesspolicy']="سياسة النفاذ/الوصول"; +$lang['study_meta_description']="يتم سرد s% التي تنتجها s% في كتالوج s%. البيانات والبيانات الوصفية متاحة من الرابط أعلاه."; +$lang['meta_description_catalog']="كتالوج البيانات يمكنك من تصفح، بحث وتنزيل البيانات والبيانات الوصفية للدراسة . "; -$lang['new_window']="فتح نافذة جديدة +$lang['new_window']="فتح في نافذة جديدة "; - - -/* End of file catalog_search_lang.php */ -/* Location: ./application/language/arabic/catalog_search_lang.php */ \ No newline at end of file +$lang['harvested_study_access_complete_metadata']="تم حصاد المعلومات المقدمة في هذه الصفحة من مستودع مساهم: %s +يمكنك تصفح وتنزيل البيانات الوصفية من هذه الصفحة. لتنزيل المواد ذات الصلة والوصول إلى البيانات، <;a href="%s"> قم بزيارة صفحة المسح في المستودع الأصلي ."; +$lang['data']="بيانات"; +$lang['by']="بواسطة"; +$lang['data_direct_description']="يتم توفير مجموعات البيانات والوثائق ذات الصلة للمستخدمين مجانًا. ليست هناك حاجة لتسجيل الدخول إلى التطبيق."; +$lang['data_public_description']="الوثائق ذات الصلة متاحة مجانا للمستخدمين. ومع ذلك ، يجب على المستخدمين تسجيل الدخول إلى التطبيق للوصول إلى مجموعات البيانات هذه."; +$lang['data_licensed_description']="الوثائق ذات الصلة متاحة مجانا للمستخدمين. يتطلب الوصول إلى مجموعات البيانات أن يتقدم المستخدم بطلب للحصول على الموافقة للوصول إلى مجموعات البيانات هذه. يجب على المستخدمين تسجيل الدخول إلى التطبيق وملء نموذج الطلب عند التقدم للحصول على حق الوصول."; +$lang['data_enclave_description']="الوثائق ذات الصلة متاحة مجانا للمستخدمين. يتطلب الوصول إلى مجموعات البيانات أن يتقدم المستخدم بطلب للحصول على الموافقة للوصول إلى مجموعات البيانات هذه في مكان وبيئة آمنة في المركز."; +$lang['data_remote_description']="الوثائق ذات الصلة متاحة مجانا للمستخدمين. يتم الاحتفاظ بمجموعات البيانات في كتالوجات في الخارج أو في مؤسسات أخرى."; +$lang['data_na_description']="الوثائق ذات الصلة متاحة مجانا للمستخدمين. ومع ذلك ، فإن مجموعات البيانات لهذه الدراسات غير متوفرة."; +$lang['data_open_description']="مجموعات البيانات والوثائق ذات الصلة للمستخدمين يتم توفيرها مجانًا."; +$lang['filter_by_data']="الوصول للبيانات"; +$lang['legend_na_access']="البيانات غير متوفرة"; +$lang['central_data_catalog']="كتالوج/فهرس البيانات المركزي"; +$lang['data_catalogs']="كتالوج/فهرس البيانات"; +$lang['visit_catalog']="قم بزيارة الكتالوج"; +$lang['catalog_owned_by']="مجموعة"; +$lang['legend_citations']="اقتباسات من المنشورات التي استخدمت الدراسة"; +$lang['catalog_history']="تاريخ/سجل الكتالوج"; +$lang['search_no_results']="

لم يتطابق بحثك مع أي دراسات أجريت في الفهرس.

+

الاقتراحات: +

    +
  • تأكد من كتابة كل الكلمات بشكل صحيح إملائيًا.
  • +
  • جرب كلمات مفتاحية مختلفة.
  • +
  • جرب كلمات مفتاحية أكثر عمومية.
  • +
  • حاول البحث في حقل وصف المتغير إذا بحثت في حقل وصف الدراسة.
  • +
      "; +$lang['filter_by_collection']="المجموعات"; +$lang['js_collections_selected']="المجموعات المختارة"; +$lang['js_collection_selected']="المجموعة المختارة"; +$lang['contributing_catalogs']="الكتالوجات المساهمة"; +$lang['study_data_files']="ملفات البيانات"; +$lang['show_all_files']="أعرض جميع الملفات"; +$lang['about_central_catalog']="حول الكتالوج/الفهرس المركزي"; +$lang['view_select_more']="عرض / تحديد المزيد"; +$lang['created_on']="أنشئت بتاريخ"; +$lang['last_modified']="آخر تعديل"; +$lang['page_views']="مشاهدات الصفحة"; +$lang['downloads']="تنزيلات"; +$lang['select_countries']="إختر البلدان"; +$lang['in_alphabatic_order']="بالترتيب الأبجدي"; +$lang['By Income']="حسب الدخل"; +$lang['By Region']="حسب المنطقة"; +$lang['cancel']="إلغاء"; +$lang['apply_filter']="تطبيق الفلتر/التصفية"; +$lang['selected_itesm']="المحدد"; +$lang['clear']="إلغاء/مسح"; +$lang['select_collections']="حدد المجموعات"; +$lang['select_topics']="حدد المواضيع"; +$lang['reset_search']="إعادة البحث"; +$lang['prev']="السابق"; +$lang['next']="التالي"; +$lang['search_by_keyword']="بحث حسب الكلمات المفتاحية"; +$lang['filter_by_year']="السنوات"; +$lang['any']="الكل"; +$lang['views']="المشاهدات"; +$lang['metadata']="البيانات الوصفية"; +$lang['popularity']="شعبية"; +$lang['To compare, select two or more variables']="للمقارنة ، حدد متغيرين أو أكثر"; +$lang['related_materials_tab_info']="الوثائق ذات الصلة: إستمارات، تقارير ، وثائق فنية ، جداول"; +$lang['study_description_tab_info']="البيانات الوصفية للدراسة: نظرة عامة ، ملخص ، العينات ، التمويل ، المعالجة ، سياسة الوصول"; +$lang['related_citations_tab_info']="روابط للمنشورات التي استخدمت البيانات من هذه الدراسة"; +$lang['data_dictionary_tab_info']="وصف ملفات البيانات والمتغيرات"; +$lang['featured_study']="دراسة مميزة"; +$lang['dataset_type_survey']="البيانات الجزئية"; +$lang['dataset_type_table']="جداول"; +$lang['dataset_type_document']="وثائق"; +$lang['dataset_type_geospatial']="البيانات الجغرافية المكانية"; +$lang['dataset_type_image']="صور"; +$lang['variables']="متغيرات"; +$lang['total']="المجموع"; +$lang['data_file']="ملف بيانات"; +$lang['data_files']="ملفات بيانات"; +$lang['cases']="حالات"; +$lang['metadata_in_json']="بيانات وصفية JSON"; +$lang['metadata_in_ddi_xml']="كتاب الترميز DDI (2.5)"; +$lang['tab_document']="وثائق"; +$lang['tab_geospatial']="البيانات الجغرافية المكانية"; +$lang['tab_image']="صور"; +$lang['tab_script']="سكريبتات/برامج نصية"; +$lang['tab_table']="جداول"; +$lang['tab_timeseries']="سلاسل زمنية"; +$lang['tab_visualization']="تصورات مرئية"; +$lang['tab_survey']="بيانات جزئية"; +$lang['tab_video']="فيديوهات"; +$lang['from']="من"; +$lang['to']="إلى"; +$lang['filter_by_tag']="علامات Tags"; +$lang['data_classification']="تصنيف البيانات"; +$lang['select_data_classification']="حدد تصنيف البيانات"; +$lang['Photo']="صورة"; +$lang['geospatial_description']="وصف"; +$lang['timeseries_description']="وصف السلسلة الزمنية"; +$lang['timeseries_db']="مصدر قاعدة البيانات"; +$lang['document_description']="وصف الوثيقة"; +$lang['table_description']="وصف الجدول"; +$lang['image_description']="وصف الصورة"; +$lang['script_description']="وصف المشروع"; +$lang['visualization_description']="وصف التصورات المرئية"; +$lang['microdata_description']="وصف الدراسة"; +$lang['data_dictionary']="وصف البيانات"; +$lang['get_microdata']="الحصول على البيانات الجزئية"; +$lang['related_materials']="تنزيلات"; +$lang['related_citations']="مطبوعات ذات صلة"; +$lang['study_resources']="تنزيل الموارد ذات صلة"; +$lang['study_microdata_resources']="تنزيل البيانات الجزئية"; +$lang['Total variables(s)']="مجموع المتغيرات"; +$lang['download_study_rdf']="قم بتنزيل أوصاف موارد الدراسة (مثل التقارير والاستبيانات والوثائق الفنية) بتنسيق Dublin Core RDF"; +$lang['download_study_ddi']="قم بتنزيل البيانات الوصفية للدراسة بتنسيق DDI (XML)"; +$lang['study_documentation_text']="قم بتنزيل الاستبيانات والوثائق الفنية والتقارير التي تصف عملية المسح والنتائج الرئيسية لهذه الدراسة."; +$lang['study_description_text']="يقدم القسم وصفًا تفصيليًا للدراسة (أي البيانات الوصفية). تتعلق الموضوعات التي يتم تناولها بمنهجية المسح وطرق أخذ العينات وجمع البيانات والتمويل وتواريخ الجمع والتغطية الجغرافية وسياسة الوصول إلى البيانات من هذه الدراسة. قم بتنزيل البيانات الوصفية بعدد من التنسيقات من رابط تصدير البيانات الوصفية."; +$lang['data_description_text']="يقدم هذا القسم معلومات مفصلة عن بيانات سجل الوحدة الناتجة عن هذه الدراسة. يتضمن هذا وصفًا تفصيليًا لمحتويات كل ملف بيانات وجميع المتغيرات داخل كل ملف. قد تحتوي المتغيرات على النتائج المسجلة لسؤال مباشر مطروح ، أو مشتقة بطريقة ما. يتم تلخيص عدد المتغيرات وعدد نقاط البيانات (الحالات) لكل متغير."; +$lang['related_publications_text']="يتم استخدام البيانات من هذه الدراسة في المنشورات التالية:"; +$lang['related_studies']="الدراسات ذات الصلة"; +$lang['variable_group']="مجموعة المتغير"; +/* End of file catalog_search */ +/* Location: ./application/language/arabic/catalog_search */ \ No newline at end of file diff --git a/application/language/arabic/citations_lang.php b/application/language/arabic/citations_lang.php index 5a0dc0df5..1f834f82f 100644 --- a/application/language/arabic/citations_lang.php +++ b/application/language/arabic/citations_lang.php @@ -3,22 +3,22 @@ $lang['title']="العنوان"; $lang['subtitle']="العنوان الفرعي"; $lang['volume']="مجلد"; -$lang['issue']="مسألة"; +$lang['issue']="إصدار"; $lang['edition']="طبعة"; -$lang['page_numbers']="صفحة رقم"; -$lang['isbn']="isbn"; -$lang['provide_link_to_document']="تقديم وصلة للوثيقة"; -$lang['related_studies']="المسوح المرتبطة"; -$lang['add_related_studies']="اضافة مسوح مرتبطة"; -$lang['select_studies']="اختر مسوح"; -$lang['add_new_citation']="اضافة اقتباس جديد"; -$lang['edit_citation']="تعديل اقتباس"; +$lang['page_numbers']="أرقام الصفحات"; +$lang['isbn']="رقم ISBN"; +$lang['provide_link_to_document']="تزويد رابط للوثيقة"; +$lang['related_studies']="دراسات ذات صلة"; +$lang['add_related_studies']="أضف الدراسات ذات الصلة"; +$lang['select_studies']="اختر الدراسات"; +$lang['add_new_citation']="أضف إقتباس جديد"; +$lang['edit_citation']="حرر الإقتباس"; $lang['select_citation_type']="اختر نوع الاقتباس"; -$lang['first_name']="الاسم "; +$lang['first_name']="الاسم الأول"; $lang['last_name']="اللقب"; -$lang['middle_initial']="الحرف الأول من الإسم"; +$lang['middle_initial']="أول حرف من اسم الأب"; $lang['publisher']="الناشر"; -$lang['publication_day_month_year']="نشر (اليوم / الشهر / السنة)"; +$lang['publication_day_month_year']="تاريخ النشر (اليوم / الشهر / السنة)"; $lang['publication_city']="المدينة"; $lang['publication_state_country']="البلد / الدولة"; $lang['citation_type']="نوع"; @@ -26,84 +26,88 @@ $lang['citation_information']="معلومات عن الاقتباس"; $lang['Book']="كتاب"; $lang['Book Section']="فصل من كتاب"; -$lang['Anthology (Author & Editor)']="مختارات (المؤلف,الناشر)"; -$lang['Anthology (Author & Translator)']="مختارات (المؤلف,المترجم)"; -$lang['Journal']="مرجع"; +$lang['Anthology (Author & Editor)']="مختارات (مؤلف ومحرر)"; +$lang['Anthology (Author & Translator)']="مختارات (مؤلف ومترجم)"; +$lang['Journal']="مقال المجلة"; $lang['Magazine']="مجلة"; $lang['Newspaper']="صحيفة يومية"; -$lang['Website']="موقع ويب"; -$lang['Website Document']="وثيقةعلى الويب"; +$lang['Website']="الموقع الإلكتروني"; +$lang['Website Document']="وثيقة على الويب"; $lang['book']="كتاب"; $lang['book-section']="فصل من كتاب"; -$lang['anthology-editor']="مختارات"; -$lang['Anthology-translator']="مختارات"; +$lang['anthology-editor']="مختارات - محرر"; +$lang['Anthology-translator']="مختارات - مترجم"; $lang['journal']="مرجع"; $lang['magazine']="مجلة"; $lang['newspaper']="صحيفة يومية"; $lang['website']="موقع ويب"; $lang['website-doc']="وثيقةعلى الويب"; $lang['abstract']="ملخص"; -$lang['working-paper']="وثيقة عمل"; -$lang['conference-paper']="مقال نشر فى مؤتمر"; +$lang['working-paper']="ورقة عمل"; +$lang['conference-paper']="ورقة نشرت فى مؤتمر"; $lang['report']="تقرير"; -$lang['anthology-organization']="مختارات (المنظمة و الناشر)"; +$lang['anthology-organization']="مختارات (المنظمة والمحرر)"; $lang['conference_title']="عنوان المؤتمر"; $lang['thesis']="أطروحة"; $lang['thesis_type']="نوع الأطروحة (على سبيل المثال دكتوراه)"; -$lang['name_academic_institute']="اسم المدرسة / الجامعة"; -$lang['thesis_prepare_year']="سنةالإعداد "; +$lang['name_academic_institute']="اسم المؤسسة الأكاديمية"; +$lang['thesis_prepare_year']="سنة الإعداد "; $lang['page_to']="الى الصفحة"; -$lang['page_from']="من الصفح"; -$lang['periodical_number']="ISBN/ISSNاو رقم اخر"; +$lang['page_from']="من الصفحة"; +$lang['periodical_number']="ISBN/ISSN أو رقم اخر"; $lang['article_title']="عنوان المقالة"; -$lang['journal_title']="مرجع"; -$lang['corporate-author']="المؤلف -- الشركة"; -$lang['citation_home']="عودة إلى صفحة الاستشهادات"; +$lang['journal_title']="مجلة"; +$lang['corporate-author']="كاتب مشارك"; +$lang['citation_home']="الصفحة الرئيسية "; $lang['country']="البلد"; -$lang['import_citation']="توريد استشهادات"; -$lang['paste_citation_string']="لصق النص الاستشهادات"; -$lang['citation_url']="URL الاستشهادات"; -$lang['citation_import_status']="%sاقتباسات تم استيرادهابنجاح, %s تم تخطيها"; -$lang['citation_import_format']="اختيار صيغة توريد الاقتباس"; +$lang['import_citation']="إستيراد الاقتباسات"; +$lang['paste_citation_string']="لصق نص الاقتباس"; +$lang['citation_url']="عنوان الإقتباس على الويب URL"; +$lang['citation_import_status']="s% اقتباسات تم استيرادهابنجاح, s% تم تخطيها"; +$lang['citation_import_format']="اختيار صيغة الاقتباس المستورد"; $lang['magazine_title']="عنوان المجلة"; $lang['newspaper_title']="عنوان الصحيفة اليومية"; $lang['website_document_title']="عنوان الوثيقة"; $lang['website_organization']="اسم المنظمة "; -$lang['website_access_date']="اخرتاريخ للنفاذ"; +$lang['website_access_date']="آخر تاريخ للنفاذ"; $lang['icon_note']="ملاحظات "; -$lang['icon_no_related_study']="لا توجد دراسات ذات صلة"; -$lang['icon_related_study']="توجد دراسات ذات صلة"; -$lang['icon_flag']="رفعت براية - "; +$lang['icon_no_related_study']="لا توجد دراسات ذات صلة مرفقة"; +$lang['icon_related_study']="الدراسات المرفقة ذات الصلة "; +$lang['icon_flag']="وضع علامة "; $lang['tobe_checked']="يجب التحقق منه"; -$lang['incomplete']="غير كامل +$lang['incomplete']="غير مكتمل"; +$lang['ds_unclear']="مجموعة البيانات ذات الصلة غير الواضحة"; +$lang['duplicate']="مكررة "; -$lang['ds_unclear']=" بيانات ذات صلةو لكن غير واضحة +$lang['back_to_editor']="العودة إلى المحرر "; -$lang['duplicate']="مكررة -"; -$lang['back_to_editor']="العودة إلى المحرر -"; -$lang['clear_selection']="العودة إلى محرر -"; -$lang['flag_entry_as']="اقتباسات رفعت براية -"; -$lang['published']="الناشر"; +$lang['clear_selection']="إلغاء/مسح الإختيار"; +$lang['flag_entry_as']="علامة الاقتباس (الاقتباسات) باسم"; +$lang['published']="نشرت"; $lang['option_publish']="انشر"; $lang['option_do_not_publish']="لا تنشر"; $lang['publish_citation']="انشر الاقتباسات"; -$lang['doi']="معرف الكائن الرقمي -"; +$lang['doi']="معرّف الكائن الرقمي (DOI)"; $lang['notes']=" ملاحظات (مرئية فقط للمسؤول)"; -$lang['show_all_flag_entries']="عرض كل الاقتباسات التي رفعت براية - -"; -$lang['show_all_note_entries']="عرض كل الاقتباسات مع ملاحظات +$lang['show_all_flag_entries']="إظهار كافة الاقتباسات التي تم وضع علامة عليها "; +$lang['show_all_note_entries']="إظهار كافة الاقتباسات مع ملاحظات"; $lang['icon_user']="اسم المالك"; $lang['citation_owner']="مالك"; -$lang['created']="انشاء"; - - -/* End of file citations_lang.php */ -/* Location: ./application/language/arabic/citations_lang.php */ \ No newline at end of file +$lang['created']="أنشئت"; +$lang['citation_string_invalid']="تنسيق اقتباس غير متوقع أو غير صحيح"; +$lang['attach_to_survey']="أرفق الاقتباس (الاقتباسات) بالدراسات التالية (استخدم CTRL / SHIFT لتحديد دراسات متعددة)"; +$lang['attach_studies']="إرفاق الدراسات"; +$lang['citations_text']="فهرس المنشورات التي أقتيست بإستخدام مجموعة بيانات مدرجة في هذا الكتالوج. سيؤدي تحديد منشور من القائمة إلى إظهار مجموعة بيانات الدراسة التي تم استخدامها وتوفير رابط للدراسة في الكتالوج."; +$lang['allowed_file_types']="أنواع الملفات المسموح بها"; +$lang['attach_file']="أرفق ملف"; +$lang['max_upload_limit']="الحد الأقصى للتحميل"; +$lang['export_citations']="تصدير الاقتباسات"; +$lang['export_to_csv']="تصدير إلى CSV"; +$lang['sort']="رتب"; +$lang['published-status-1']="منشور"; +$lang['published-status-0']="مسودة"; + + +/* End of file citations */ +/* Location: ./application/language/arabic/citations */ \ No newline at end of file diff --git a/application/language/arabic/collection_lang.php b/application/language/arabic/collection_lang.php new file mode 100644 index 000000000..c98678195 --- /dev/null +++ b/application/language/arabic/collection_lang.php @@ -0,0 +1,53 @@ + config / email.php ."; +$lang['test_email_configurations']="اختبار إعدادات البريد الإلكتروني"; + + +/* End of file configurations */ +/* Location: ./application/language/arabic/configurations */ \ No newline at end of file diff --git a/application/language/arabic/da_collection_lang.php b/application/language/arabic/da_collection_lang.php new file mode 100644 index 000000000..728c9c8bb --- /dev/null +++ b/application/language/arabic/da_collection_lang.php @@ -0,0 +1,19 @@ +%d ملفات مؤقتة ,اضغط هنا لحذف هاته الملفات."; - - -/* End of file dashboard_lang.php */ -/* Location: ./application/language/arabic/dashboard_lang.php */ \ No newline at end of file +$lang['bug_report']="خبر عن خلل/ اقترح تحسين +"; +$lang['run_database_backup_script']="تشغيل برنامج النسخ الاحتياطي +"; +$lang['no_cache_files_found']="لم يتم العثور على اي ملفات مؤقتة/كاش "; +$lang['clear_cache_files']="هناك %d ملفات مؤقتة , اضغط هنا لحذف هذه الملفات."; +$lang['recent_studies']="الدراسات التي تم تحديثها مؤخرًا"; +$lang['logged_in_users']="المستخدمين المسجلين دخول "; +$lang['anonymous_users']="المستخدمون المجهولون الذين يستعرضون الموقع"; +$lang['Maintenance']="إدارة الدراسات"; +$lang['Administrators']="المسؤولون"; +$lang['History']="تاريخ/سجل"; +$lang['Edit']="تحرير المجموعة"; +$lang['Collection']="مجموعة"; +$lang['collection_contains_n_studies']="تحتوي المجموعة على d% دراسات"; +$lang['catalog_contains_n_studies']="يحتوي الكتالوج على d% دراسات"; +$lang['studies_with_no_data_files']="دراسات بدون ملفات بيانات للإستخدام العام PUF"; +$lang['studies_with_no_questionnaires']="دراسات بدون إستمارات"; +$lang['owned']="مملوكة"; +$lang['linked']="مرتبط"; +$lang['published']="منشورة"; +$lang['unpublished']="غير منشورة"; + + +/* End of file dashboard */ +/* Location: ./application/language/arabic/dashboard */ \ No newline at end of file diff --git a/application/language/arabic/data_enclave_lang.php b/application/language/arabic/data_enclave_lang.php index 2fd9cb964..e18ca16b3 100644 --- a/application/language/arabic/data_enclave_lang.php +++ b/application/language/arabic/data_enclave_lang.php @@ -1,16 +1,15 @@ أنشئ المركز الوطني للبيانات من قبل الأرشيف الوطني وذلك للسماح للعلماء الذين يستوفون شروطا معينة النفاذ الى البيانات الفردية وفق شروطا معينة وتحت رقابة صارمة. يسمح المركز النفاذ الى البيانات الجزئية في بيئة امنة ، وذلك دون المساس بسرية البيانات.

      -

      المكان

      -

      المركز الوطني للبيانات يوجد في[ضع اسم الموقع هنا]

      -

      عمليات المركز الوطني للبيانات

      - -

      كما يمكن للباحثين النفاذ إلى البيانات على مركز البيانات الوطني، حيث يتم تزويدهم بالبيانات ، - بمعدات الحاسوب والبرمجيات و تحت إشراف الموظفين.

      "; -$lang['data_enclave_application_form_link']="انقر هنا لتحميل النموذج للنفاذ إلى مركز البيانات الوطني +$lang['data_enclave_description']="

      أنشئ المركز الوطني للبيانات من قبل الأرشيف الوطني وذلك للسماح للباحثيين الذين يستوفون شروطا معينة النفاذ الى البيانات الفردية وفق شروطا معينة وتحت رقابة صارمة. يسمح المركز النفاذ الى البيانات الجزئية في بيئة امنة ، وذلك دون المساس بسرية البيانات.

      +

      المكان

      +

      المركز الوطني للبيانات يوجد في [ضع اسم الموقع هنا]

      +

      عمليات المركز الوطني للبيانات

      + +

      كما يمكن للباحثين النفاذ إلى البيانات على مركز البيانات الوطني، حيث يتم تزويدهم بالبيانات ، بمعدات الحاسوب والبرمجيات و تحت إشراف الموظفين.

      "; +$lang['data_enclave_application_form_link']="انقر هنا لتحميل النموذج للنفاذ إلى مركز البيانات الوطني "; - - -/* End of file data_enclave_lang.php */ -/* Location: ./application/language/arabic/data_enclave_lang.php */ \ No newline at end of file + + +/* End of file data_enclave */ +/* Location: ./application/language/arabic/data_enclave */ \ No newline at end of file diff --git a/application/language/arabic/dd_help_lang.php b/application/language/arabic/dd_help_lang.php new file mode 100644 index 000000000..eb749727c --- /dev/null +++ b/application/language/arabic/dd_help_lang.php @@ -0,0 +1,267 @@ + أدخل العنوان الرسمي للمسح. يمكن أن يكون العنوان باللغة الإنجليزية أو بلغة المسح. قم بتضمين السنة (السنوات) المرجعية ، لكن لا تقم بتضمين اختصار المسح أو اسم الدولة كجزء من العنوان. اجعل الحرف الأول من كل كلمة كبيرًا (باستثناء حروف الجر أو حروف العطف الأخرى). للعناوين بالفرنسية والإنجليزية والبرتغالية وما إلى ذلك ، يجب توفير أحرف مشددة. مثال: “Enquête Démographique et de Santé 2008-2009”.

      "; +$lang['altTitl']="

      أدخل اختصار المسح (بما في ذلك الحرف الأول من اسم البلد إذا كان ذلك مناسبًا). يمكن تضمين السنة (السنوات) المرجعية للمسح. مثال: DHS 2008-09.

      "; +$lang['serName']="

      نوع الدراسة أو نوع المسح هو الفئة العامة التي تحدد المسح. حدد خيارًا واحدًا من القائمة المنسدلة. حدد "أخرى" إذا لم يتطابق أي من الخيارات مع المسح الخاص بك. "; +$lang['serInfo']="

      قد يتكرر المسح على فترات منتظمة (مثل مسح القوى العاملة السنوي) ، أو يكون جزءًا من برنامج مسح دولي (مثل MICS ، CWIQ ، DHS ، LSMS وغيرها). معلومات السلسلة هي وصف لهذه "المجموعة" من المسوح. سيتم هنا تقديم وصف موجز لخصائص المسح ، بما في ذلك وقت بدئه ، وعدد الجولات التي تم تنفيذها بالفعل ، ومن المسؤول. إذا كان المسح لا ينتمي إلى سلسلة ، فاترك هذا الحقل فارغًا. "; +$lang['parTitl']="

      سيتم ترك هذا الحقل فارغًا في معظم الحالات. في البلدان التي بها أكثر من لغة رسمية واحدة ، قد يتم توفير ترجمة للعنوان. "; +$lang['IDNo']="

      +رقم معرّف مجموعة البيانات هو رقم فريد يُستخدم لتحديد مسح معين. حدد واستخدم مخططًا متسقًا لاستخدامه. يمكن إنشاء مثل هذا المعرف على النحو التالي: الدولة-المنتج-المسح-العام-الإصدار  حيث
      +- البلد هو اختصار البلد المكون من 3 أحرف ISO
      +- المنتج هو اختصار الوكالة المنتجة
      +- المسح هو اختصار المسح
      +- السنة هي السنة المرجعية (أو السنة التي بدأ فيها المسح)
      +- الإصدار هو رقم إصدار مجموعة البيانات الرقمية (انظر وصف الإصدار أدناه)
      +
      "; +$lang['version']="
      +

      يجب أن يحتوي وصف الإصدار على رقم إصدار متبوعًا بوصف الإصدار. أمثلة: +

      +

        +
      • الإصدار 0.1: البيانات الأولية الأساسية التي تم الحصول عليها من إدخال البيانات (قبل التحرير). +
      • الإصدار 1.2: البيانات المعدلة ، الإصدار الثاني ، للاستخدام الداخلي فقط.
      • +
      • الإصدار 2.1: مجموعة بيانات معدلة ومجهولة للتوزيع العام.
      • +يجب أن يتبع الوصف المختصر للإصدار التعريف العددي. +
      +

      "; +$lang['version_idate']="

      هذا هو التاريخ بتنسيق ISO (yyyy-mm-dd) للإنتاج الفعلي والنهائي للبيانات. قم بتزويد الشهر والسنة على الأقل.

      "; +$lang['version_notes']="

      يجب أن تقدم ملاحظات الإصدار تقريرًا موجزًا عن التغييرات التي تم إجراؤها من خلال عملية الإصدار. يجب أن تشير الملاحظة إلى كيفية اختلاف هذا الإصدار عن الإصدارات الأخرى لمجموعة البيانات نفسها. "; +$lang['overview_abstract']="

      يجب أن يقدم الملخص ملخصًا واضحًا لأغراض وأهداف ومحتوى المسح.

      "; +$lang['instructions_project_submit']="

      بمجرد اقتناعك بأن المعلومات التي أدخلتها لدراستك صحيحة ، فأنت جاهز لإرسال مشروعك. الرجاء تحديد سياسة وصول مناسبة لتوزيع البيانات ، أو كتالوج يجب نشر البيانات فيه ، أو أي ملاحظات قد تكون لديك بشأن عمليات الحظر ، أو المعلومات الحساسة التي يجب إزالتها قبل التوزيع أو أي ملاحظات أو تعليمات خاصة أخرى تريدها لتقديمها إلى مكتبة البيانات الجزئية. "; +$lang['instructions_project_contributor_review']="

      بمجرد اقتناعك بأن المعلومات التي أدخلتها لدراستك صحيحة ، فأنت جاهز لإرسال مشروعك. الرجاء تحديد سياسة وصول مناسبة لتوزيع البيانات ، أو كتالوج يجب نشر البيانات فيه ، أو أي ملاحظات قد تكون لديك بشأن عمليات الحظر ، أو المعلومات الحساسة التي يجب إزالتها قبل التوزيع أو أي ملاحظات أو تعليمات خاصة أخرى تريدها لتقديمها إلى مكتبة البيانات الجزئية. "; +$lang['instructions_datafiles_usage']="

      حمّل جميع الملفات التي ترغب في مشاركتها. يتضمن ذلك ملفات البيانات (بأي تنسيق) والاستبيانات وأدوات المسح الأخرى ووصف المنهجية وملفات البرامج وأي تقارير. بمجرد تحميل الملفات ، يرجى استخدام رابط تحرير (الخط الأزرق) أدناه لتحديد نوع الملف أو المستند المناسب لهذا المورد. يجب توفير ملفات البيانات والاستبيان كحد أدنى. "; +$lang['instructions_citations']="

      إذا نشرت عملاً يستخدم مجموعة البيانات المودعة ، يمكنك إدخال معلومات الاقتباس الخاصة بها في هذا القسم. ستتم إضافة هذه المراجع إلى صفحة العرض الخاصة بدراستك بمجرد نشرها في كتالوجات مكتبة البيانات الجزئية. "; +$lang['anlyUnit']="

      الوحدة (الوحدات) الأساسية للتحليل أو الملاحظة التي تصفها الدراسة: الأفراد ، والأسر / الأسر ، والمجموعات ، والمرافق ، والمؤسسات / المنظمات ، والوحدات الإدارية ، والمواقع المادية ، وما إلى ذلك. +

      أمثلة: +

      +

        +
      • مسح مستويات المعيشة باستخدام استبيان على مستوى المجتمع سيشتمل على وحدات التحليل التالية: الأفراد والأسر والمجتمعات. +
      • يمكن أن يكون للمسح الاقتصادي الشركة والمؤسسة كوحدات تحليل.
      +

      "; +$lang['dataKind']="

      هذا الحقل هو تصنيف واسع للبيانات ويرتبط بمربع منسدل يوفر مفردات مضبوطة.

      "; +$lang['keyword']="

      تلخص الكلمات المفتاحية المحتوى أو موضوع المسح. كتصنيفات للموضوعات ، يتم استخدامها لتسهيل الإحالة والبحث في كتالوجات المسح.

      "; +$lang['scope_notes']="

      النطاق عبارة عن وصف للموضوعات التي يغطيها المسح. يمكن اعتباره ملخصًا للوحدات التي تم تضمينها في الاستبيان. النطاق لا يتعامل مع التغطية الجغرافية.

      +

      مثال: +

      يشمل نطاق المسح العنقودي متعدد المؤشرات: +

        +
      • المنزل: خصائص الأسرة ، وقائمة الأسرة ، والأطفال الأيتام والضعفاء ، والتعليم ، وعمالة الأطفال ، والمياه والصرف الصحي ، والاستخدام المنزلي للناموسيات المعالجة بمبيدات الحشرات ، ومعالجة الملح باليود ، مع وحدات اختيارية لتأديب الأطفال ، وإعاقة الأطفال ، ووفيات الأمهات ، و أمن الحيازة واستمرارية السكن.
      • +
      • المرأة: خصائص المرأة ، وفيات الأطفال ، وذوفان الكزاز ، وصحة الأم والوليد ، والزواج ، وتعدد الزوجات ، وختان الإناث ، ومنع الحمل ، والمعرفة بفيروس نقص المناعة البشرية / الإيدز ، مع وحدات اختيارية للاحتياجات غير الملباة ، والعنف المنزلي ، والسلوك الجنسي. < / لي> +
      • الأطفال: خصائص الأطفال ، وتسجيل المواليد والتعلم المبكر ، وفيتامين أ ، والرضاعة الطبيعية ، والعناية بالمرض ، والملاريا ، والتحصين ، والقياسات البشرية ، مع وحدة اختيارية لنمو الطفل.
      • +
          "; +$lang['topcClas']="

          يسهل تصنيف الموضوع الرجوع إلى عمليات البحث في كتالوجات المسح الإلكتروني.

          نظرًا لأن مكتبة البيانات الجزئية لم تصوغ قائمة موضوعات قياسية ، إلا أنه قد يتم ترك هذا الحقل فارغًا < p/>"; +$lang['nation']="

          أدخل اسم البلد ، حتى في الحالات التي لا يغطي فيها المسح البلد بالكامل. في حقل "الاختصار" ، نوصي بإدخال رمز ISO المكون من 3 أحرف للبلد. إذا كانت مجموعة البيانات التي توثقها تغطي أكثر من بلد ، فأدخل الكل في صفوف منفصلة.

          "; +$lang['geogCover']="

          يهدف هذا الحقل إلى وصف التغطية الجغرافية للعينة. ستكون الإدخالات النموذجية "تغطية وطنية" ، "حضرية (أو ريفية) فقط" ، "ولاية ..." ، "عاصمة" ، إلخ.

          "; +$lang['country_universe']="

          نحن مهتمون هنا بعالم المسح(وليس عالم أقسام معينة من الاستبيانات أو المتغيرات) ، أي تحديد السكان المعنيين بالمسح. نادرًا ما يكون الكون هو كل سكان البلاد. على سبيل المثال ، لا تغطي عينات المسوحات المنزلية ، عادة المشردين والبدو والدبلوماسيين وأسر المجتمع. قد تغطي بعض المسوح السكان من فئة عمرية معينة فقط ، أو الذكور فقط (أو الإناث) ، وما إلى ذلك.

          "; +$lang['AuthEnty']="

          الباحث الرئيسي هو المؤسسة (أو في بعض الحالات الفرد (الأفراد)) الذي كان مسؤولاً عن تصميم وتنفيذ المسح (وليس التمويل أو المساعدة الفنية).

          +

          الترتيب الذي يتم سردها به تقديري. يمكن أن تكون أبجدية أو حسب أهمية المساهمة.

          "; +$lang['AuthEnty_iaffiliation']="التبعية +"; +$lang['producers']="

          الاختصار والتبعية والدور. إذا كان أي من الحقول غير قابل للتطبيق ، فيمكن تركها فارغة. يجب أن تكون الاختصارات هي الاختصار الرسمي للمنظمة.

          +

          يجب أن يكون الدور عبارة أو وصفًا قصيرًا وموجزًا للمساعدة المحددة التي تقدمها المنظمة لإنتاج البيانات.

          +

          أمثلة على الأدوار: +

            +
          • [المساعدة الفنية في] تصميم الاستبيان +
          • [المساعدة الفنية في] منهجية / اختيار العينات +
          • [المساعدة الفنية في] جمع البيانات +
          • [مساعدة فنية في] معالجة البيانات +
          • [المساعدة الفنية في] تحليل البيانات +

            لا تضم الرعاة الماليين هنا. "; +$lang['fundAg']="

            ضع قائمة بالمنظمات (الوطنية أو الدولية) التي ساهمت ، نقدًا أو عينيًا ، في تمويل المسح.

            "; +$lang['othId_p']="

            يمكن استخدام هذا الحقل الاختياري لتقدير أي أشخاص ومؤسسات أخرى ساهمت بشكل ما في المسح.

            "; +$lang['sampProc']="

            ينطبق هذا الحقل فقط على المسوح بالعينة. المعلومات عن إجراءات أخذ العينات أمر بالغ الأهمية (على الرغم من أنها لا تنطبق على التعدادات ومجموعات البيانات الإدارية). يجب أن يتضمن هذا القسم معلومات موجزة تتضمن على الرغم من أنها لا تقتصر على: +

              +
            • حجم العينة +
            • عملية الاختيار (على سبيل المثال ، الاحتمالية المتناسبة مع الحجم أو العينات الزائدة) +
            • التقسيم الطبقي (ضمني وصريح)
            • +
            • مراحل اختيار العينة) +
            • إغفال التصميم في العينة) +
            • مستوى التمثيل) +
            • استراتيجية للمستجيبين الغائبين / غير موجود / رفض (استبدال أم لا)) +
            • نموذج الإطار المستخدم ، وتمرين القائمة الذي تم إجراؤه لتحديثه) +

              من المفيد أيضًا الإشارة هنا إلى المتغيرات الموجودة في ملفات البيانات التي تحدد المستويات المختلفة للطبقات ووحدة العينة الأولية. هذه ضرورية لمستخدمي البيانات الذين يرغبون في حساب تصميم العينة بشكل صحيح في تحليلاتهم وحساباتهم لأخطاء أخذ العينات.

              +

              يقبل هذا القسم تنسيق النص فقط ؛ لا يمكن إدخال الصيغ. في معظم الحالات ، ستتوفر المستندات الفنية التي تصف استراتيجية أخذ العينات بالتفصيل. في مثل هذه الحالات ، قم بتضمين مرجع (العنوان / المؤلف / التاريخ) لهذا المستند ، وتأكد من تحميل المستند في ملفات البيانات وقسم الموارد الأخرى.

              "; +$lang['deviat']="

              ينطبق هذا الحقل فقط على المسوح بالعينة. +

              أحيانًا يتطلب واقع المجال انحرافًا عن تصميم العينة (على سبيل المثال بسبب صعوبة الوصول إلى المناطق بسبب مشاكل الطقس وعدم الاستقرار السياسي وما إلى ذلك). إذا انحرف تصميم العينة لأي سبب من الأسباب ، فيجب الإبلاغ عن ذلك هنا.

              "; +$lang['respRate']="

              يوفر معدل الاستجابة تلك النسبة المئوية للأسر (أو وحدة عينة أخرى) التي شاركت في المسح بناءً على حجم العينة الأصلي. قد يحدث الإغفال بسبب رفض المشاركة ، أو استحالة تحديد مكان المدعى عليه ، أو غير ذلك. في بعض الأحيان ، قد يتم استبدال منزل بآخر بالتصميم. تحقق من أن المعلومات المقدمة هنا متوافقة مع حجم العينة المشار إليه في حقل "إجراء أخذ العينات" وعدد السجلات الموجودة في مجموعة البيانات (على سبيل المثال ، إذا ذكر تصميم العينة عينة من 5000 أسرة وكانت البيانات الموجودة بها تحتوي على بيانات عن 4500 أسرة ، يجب ألا يكون معدل الاستجابة 100 بالمائة). +

              قدِّم ، إن أمكن ، معدلات الاستجابة حسب الطبقة. إذا كانت المعلومات متوفرة حول أسباب عدم الاستجابة (الرفض / لم يتم العثور على / غير ذلك) ، فقم بتوفير هذه المعلومات أيضًا. +

              يمكن أيضًا استخدام هذا الحقل في بعض الحالات لوصف عدم الاستجابات في تعدادات السكان. "; +$lang['weight']="ينطبق هذا الحقل فقط على عينات المسوحات أو عينات التعداد. +

              قدم هنا قائمة المتغيرات المستخدمة كمعامل ترجيح. إذا كان هناك أكثر من متغير واحد هو متغير ترجيح/وزن ، فقم بوصف كيف تختلف هذه المتغيرات عن بعضها البعض والغرض من كل منها.

              +

              مثال: +

              تم حساب أوزان العينات لكل ملف من ملفات البيانات. +

              تم حساب أوزان العينات لبيانات الأسرة على أنها معكوس احتمال اختيار الأسرة ، محسوبة على مستوى مجال أخذ العينات (حضري / ريفي داخل كل منطقة). تم تعديل أوزان الأسرة لعدم الاستجابة على مستوى المجال ، ثم تم تطبيعها بعامل ثابت بحيث يساوي العدد الإجمالي المرجح للأسر إجمالي عدد الأسر غير المرجح. يُطلق على متغير وزن الأسرة اسم HHWEIGHT ويتم استخدامه مع بيانات HH وبيانات HL.

              +

              استخدمت أوزان العينات لبيانات النساء الأوزان المنزلية غير المعيارية ، وتعديلها لعدم الاستجابة لاستبيان النساء ، ثم تمت معايرتها بعامل ثابت بحيث يساوي العدد الإجمالي المرجح لحالات النساء إجمالي عدد غير مرجح من حالات نسائية. +

              اتبعت أوزان العينات لبيانات الأطفال نفس نهج النساء واستخدمت أوزان الأسرة غير المعيارية ، مع تعديلها لعدم الاستجابة لاستبيان الأطفال ، ثم تم تطبيعها بعامل ثابت بحيث يكون إجمالي العدد المرجح حالات الأطفال تساوي إجمالي عدد غير مرجح لحالات الأطفال. "; +$lang['collDate']="

              أدخل التواريخ (الشهر والسنة على الأقل) لبداية جمع البيانات ونهايته.

              +

              في بعض الحالات ، يمكن إجراء جمع البيانات لنفس المسح على شكل موجات. في مثل هذه الحالة ، يجب عليك إدخال تاريخ البداية والنهاية لكل موجة على حدة ، وتحديد كل موجة في حقل "الدورة".

              "; +$lang['timePrd']="

              عادةً ما يُترك هذا الحقل فارغًا. تختلف الفترة الزمنية عن تواريخ الجمع لأنها تمثل الفترة التي تكون فيها البيانات التي تم جمعها قابلة للتطبيق أو ذات صلة.

              "; +$lang['collMode']="

              أسلوب جمع البيانات هو الطريقة التي أجريت بها المقابلة أو تم جمع المعلومات بها. هذا المجال هو حقل مفردات مضبوطة.

              +

              استخدم زر القائمة المنسدلة لتحديد خيار واحد. في معظم الحالات ، سيكون الرد "مقابلة وجهاً لوجه". ولكن بالنسبة لبعض أنواع مجموعات البيانات المحددة ، مثل البيانات المتعلقة بسقوط المطر على سبيل المثال ، ستكون الاستجابة مختلفة. "; +$lang['collSitu']="

              تم توفير هذا العنصر لتوثيق أي ملاحظات أو وقائع أو أحداث محددة أثناء جمع البيانات. ضع في اعتبارك ذكر عناصر مثل: +

                +
              • هل تم إجراء تدريب للعداد؟ (تفصيل)
              • +
              • أية أحداث يمكن أن يكون لها تأثير على جودة البيانات؟
              • +
              • كم من الوقت استغرقت المقابلة في المتوسط؟
              • +
              • هل كانت هناك عملية تفاوض بين الأسر والمجتمع والوكالة المنفذة؟
              • +
              • هل يتم تسجيل الأحداث القصصية؟
              • +
              • هل ساهمت الفرق الميدانية من خلال توفير معلومات حول المشكلات والأحداث أثناء جمع البيانات؟
              • +
              • بأي لغة أجريت المقابلة؟
              • +
              • هل تم إجراء مسح تجريبي؟
              • +
              • هل اتخذت الإدارة أية إجراءات تصحيحية عند حدوث مشكلات في الميدان؟
              • +
              +

              مثال:

              +

              تم إجراء الاختبار التمهيدي للمسح في الفترة من 15 آب (أغسطس) 2006 إلى 25 آب (أغسطس) 2006 وشمل 14 من المحاورين الذين أصبحوا فيما بعد مشرفين على المسح الرئيسي. +

              يتألف كل فريق من المقابلات من 3-4 من المقابلات (لم يتم استخدام محاورين ذكور بسبب حساسية الموضوع) ، جنبًا إلى جنب مع محرر ميداني ومشرف وسائق. تم استخدام ما مجموعه 52 من المحاورين و 14 مشرفًا و 14 محررًا ميدانيًا. تم جمع البيانات على مدى 6 أسابيع تقريبًا من 2 سبتمبر 2006 حتى 17 أكتوبر 2006. جرت المقابلة يوميًا طوال فترة العمل الميداني ، على الرغم من السماح لفرق المقابلات بأخذ يوم عطلة واحد في الأسبوع.

              +

              بلغ متوسط ​​المقابلات 35 دقيقة لاستبيان الأسرة (باستثناء اختبار الملح) ، و 23 دقيقة لاستبيان النساء ، و 27 دقيقة لاستبيان الأطفال دون سن الخامسة (باستثناء قياس الأنثروبومترية). أجريت المقابلات بشكل أساسي باللغتين الإنجليزية و Mumbo-jumbo ، ولكنها استخدمت أحيانًا الترجمة المحلية إلى الهولندية المزدوجة ، عندما لا يتحدث المستفتى الإنجليزية أو Mumbo-jumbo.

              +

              قدم ستة موظفين من GenCenStat تنسيق العمل الميداني الشامل والإشراف. كان المنسق الميداني العام السيدة دو. "; +$lang['resInstru']="

              يتم توفير هذا العنصر لوصف الاستبيان (الاستبيانات) المستخدمة في جمع البيانات. يجب ذكر ما يلي: +

                +
              • قائمة الاستبيانات ووصف موجز لكل منها (يجب تقديم جميع الاستبيانات كمصادر خارجية) +
              • بأي لغة تم نشر الاستبيانات؟
              • +
              • معلومات عن عملية تصميم الاستبيان (بناءً على استبيان سابق ، بناءً على نموذج استبيان قياسي ، ومراجعة من قبل أصحاب المصلحة). إذا تم تجميع وثيقة تحتوي على التعليقات المقدمة من أصحاب المصلحة على مسودة الاستبيان ، أو تقرير معد عن اختبار الاستبيان ، فيجب تقديم إشارة إلى هذه الوثائق هنا ويجب تقديم الوثائق كمصادر خارجية.
              • +
              +

              مثال: +

              كانت الاستبيانات الخاصة بالمجموعات العنقودية متعددة المؤشرات (MICS) العامة عبارة عن استبيانات منظمة بناءً على نموذج استبيان MICS3 مع بعض التعديلات والإضافات. تم إجراء استبيان منزلي في كل أسرة ، والذي جمع معلومات عن أفراد الأسرة بما في ذلك الجنس والعمر والعلاقة وحالة اليتم. يتضمن الاستبيان المنزلي خصائص الأسرة ، ودعم الأطفال الأيتام والضعفاء ، والتعليم ، وعمالة الأطفال ، والمياه والصرف الصحي ، والاستخدام المنزلي للناموسيات المعالجة بمبيدات الحشرات ، ومعالجة الملح باليود ، مع وحدات اختيارية لتأديب الأطفال ، وإعاقة الأطفال ، ووفيات الأمهات ، وأمن الأطفال. حيازة ومتانة السكن. +

              بالإضافة إلى استبيان الأسرة ، تم إجراء الاستبيانات في كل أسرة معيشية للنساء اللائي تتراوح أعمارهن بين 15 و 49 عامًا والأطفال دون سن الخامسة. بالنسبة للأطفال ، تم إرسال الاستبيان إلى الأم أو القائمين على رعاية الطفل.

              +

              يتضمن استبيان النساء خصائص المرأة ، ووفيات الأطفال ، وذوفان الكزاز ، وصحة الأم والوليد ، والزواج ، وتعدد الزوجات ، وبتر الأعضاء التناسلية للإناث ، ومنع الحمل ، ومعرفة فيروس نقص المناعة البشرية / الإيدز ، مع وحدات اختيارية للاحتياجات غير الملباة ، والعنف المنزلي ، والسلوك الجنسي .

              +

              يتضمن استبيان الأطفال خصائص الأطفال ، وتسجيل المواليد والتعلم المبكر ، وفيتامين أ ، والرضاعة الطبيعية ، والعناية بالمرض ، والملاريا ، والتحصين ، والقياس البشري ، مع وحدة اختيارية لنمو الطفل. +

              تم تطوير الاستبيانات باللغة الإنجليزية من استبيانات نموذج MICS3 ، وتم ترجمتها إلى Mumbo-jumbo. بعد المراجعة الأولية ، تمت ترجمة الاستبيانات مرة أخرى إلى اللغة الإنجليزية بواسطة مترجم مستقل بدون معرفة مسبقة بالمسح. تمت مراجعة الترجمة الخلفية من إصدار Mumbo-jumbo بشكل مستقل ومقارنتها بالأصل الإنجليزي. تمت مراجعة الاختلافات في الترجمة وحلها بالتعاون مع المترجمين الأصليين. +

              تم تجريب كل من استبيانات اللغة الإنجليزية و Mumbo-jumbo كجزء من الاختبار القبلي للمسح. +

              يتم توفير جميع الاستبيانات والوحدات كمصادر خارجية. "; +$lang['dataCollector']="

              يتم توفير هذا العنصر لتسجيل المعلومات المتعلقة بالأشخاص و / أو الوكالات التي تولت مسؤولية جمع البيانات. يتضمن هذا العنصر 3 حقول: الاسم والاختصار والتبعية. في معظم الحالات ، نسجل هنا اسم الوكالة وليس اسم المحاورين. فقط في حالة الدراسات الاستقصائية الصغيرة جدًا ، مع وجود عدد محدود جدًا من المحاورين ، سيتم تضمين اسم الشخص أيضًا. يعد حقل الانتساب اختياريًا وليس مناسبًا في جميع الحالات. "; +$lang['cleanOps']="

              يجب أن يحتوي تحرير البيانات على معلومات حول كيفية معالجة البيانات أو التحكم فيها من حيث الاتساق والترابط. لا يتعلق هذا البند بمرحلة إدخال البيانات ولكن فقط بتحرير البيانات سواء أكان يدويًا أم آليًا.

              +
                +
              • هل كان السطح الساخن أم أسلوب السطح البارد المستخدم لتعديل البيانات؟ +
              • هل تم إجراء التصحيحات تلقائيًا (حسب البرنامج) ، أو عن طريق التحكم المرئي للاستبيان؟
              • +
              • ما هي البرامج المستخدمة؟
              • +
              +

              في حالة توفر المواد (مواصفات تحرير البيانات ، تقرير حول تحرير البيانات ، البرامج المستخدمة لتحرير البيانات) ، يجب إدراجها هنا وتحميلها في ملفات البيانات وقسم الموارد الأخرى.

              +

              مثال: +

              تم تعديل البيانات في عدد من المراحل خلال المعالجة ، بما في ذلك: +

                +
              1. التحرير والترميز المكتبي +
              2. أثناء إدخال البيانات +
              3. فحص الهيكل واكتماله +
              4. التحرير الثانوي +
              5. فحص هيكلي لملفات بيانات SPSS
              6. +
              +

              يمكن العثور على الوثائق التفصيلية لتحرير البيانات في مستند "إرشادات معالجة البيانات" المقدم كمورد خارجي. "; +$lang['method_notes']="

              استخدم هذا الحقل لتقديم أكبر قدر ممكن من المعلومات حول تصميم إدخال البيانات. يتضمن ذلك تفاصيل مثل: +

                +
              • طريقة إدخال البيانات (يدويًا أو عن طريق المسح ، في الميدان / في المناطق / في المقر الرئيسي) +
              • هندسة الكمبيوتر (أجهزة الكمبيوتر المحمولة في الميدان ، أجهزة الكمبيوتر المكتبية ، الماسحات الضوئية ، المساعد الرقمي الشخصي ، وغيرها ؛ حدد عدد أجهزة الكمبيوتر المستخدمة) +
              • البرامج المستخدمة +
              • استخدام (ومعدل) الإدخال المزدوج للبيانات +
              • متوسط ​​إنتاجية مشغلي إدخال البيانات ؛ عدد مشغلي إدخال البيانات المشاركين وجدول عملهم
              • +
              +

              يمكن أيضًا توفير معلومات حول الجدولة والتحليل هنا.

              +

              يجب إدراج جميع المواد المتاحة (برامج إدخال / جدولة / تحليل ، وتقارير عن إدخال البيانات) هنا وتقديمها كموارد خارجية. +

              مثال: +

              تمت معالجة البيانات في مجموعات ، حيث تتم معالجة كل مجموعة كوحدة كاملة خلال كل مرحلة من مراحل معالجة البيانات. تمر كل مجموعة بالخطوات التالية: +

                +
              1. استقبال الاستبيان +
              2. التحرير والترميز المكتبي +
              3. إدخال البيانات +
              4. فحص الهيكل واكتماله +
              5. إدخال التحقق +
              6. مقارنة بيانات التحقق +
              7. النسخ الاحتياطي للبيانات الأولية +
              8. التحرير الثانوي +
              9. النسخ الاحتياطي للبيانات المعدلة +

                بعد معالجة جميع المجموعات ، يتم تجميع جميع البيانات معًا ثم يتم إكمال الخطوات التالية لجميع ملفات البيانات: +

              10. تصدير إلى SPSS في 4 ملفات (hh- الأسرة ، hl - أفراد الأسرة ، wm - النساء ، ch- الأطفال دون سن 5) +
              11. إعادة ترميز المتغيرات اللازمة للتحليل +
              12. إضافة أوزان العينات +
              13. حساب خماسي الثروة ودمجها في البيانات +
              14. فحص هيكلي لملفات SPSS
              15. +
              16. جدولة جودة البيانات +
              17. إنتاج جداول التحليل +
              +

              يمكن العثور على تفاصيل كل خطوة من هذه الخطوات في وثائق معالجة البيانات وإرشادات تحرير البيانات وبرامج معالجة البيانات في CSPro و SPSS وإرشادات الجدولة. +

              تم إدخال البيانات من قبل 12 عامل إدخال بيانات في نوبتين ، تحت إشراف 2 من مشرفين إدخال البيانات ، باستخدام ما مجموعه 7 أجهزة كمبيوتر (6 أجهزة كمبيوتر لإدخال البيانات بالإضافة إلى كمبيوتر واحد للمشرفين). تم إجراء جميع عمليات إدخال البيانات في المكتب الرئيسي لشركة GenCenStat باستخدام الإدخال اليدوي للبيانات. لإدخال البيانات ، تم استخدام الإصدار 2.6.007 من CSPro مع برنامج إدخال بيانات منظم للغاية ، باستخدام نهج يتحكم فيه النظام يتحكم في إدخال كل متغير. تم التحكم في جميع عمليات فحص النطاق والتخطي بواسطة البرنامج ولم يتمكن المشغلون من تجاوزها. كما تم تضمين مجموعة محدودة من فحوصات الاتساق في برنامج إدخال البيانات. بالإضافة إلى ذلك ، تم أيضًا تضمين حساب درجات Z للقياسات البشرية في برامج إدخال البيانات لاستخدامها أثناء التحليل. لم يتم إدخال الردود المفتوحة (إجابات "أخرى") أو ترميزها ، إلا في حالات نادرة حيث تطابق الرد رمزًا موجودًا في الاستبيان.

              +

              يضمن التحقق من الهيكل والاكتمال إدخال جميع الاستبيانات الخاصة بالمجموعة ، وأنها سليمة من الناحية الهيكلية ، وأن استبيانات النساء والأطفال موجودة لكل امرأة وطفل مؤهل.

              +

              تم إجراء التحقق بنسبة 100٪ من جميع المتغيرات باستخدام التحقق المستقل ، أي الإدخال المزدوج للبيانات ، مع مقارنة منفصلة للبيانات متبوعة بتعديل إحدى مجموعتي البيانات أو كليهما لتصحيح أخطاء المفاتيح بواسطة المشغلين الأصليين الذين قاموا أولاً بإدخال الملفات.

              +

              بعد الانتهاء من جميع عمليات المعالجة في CSPro ، تم نسخ جميع ملفات المجموعات الفردية احتياطيًا قبل ربط البيانات معًا باستخدام الأداة المساعدة لسلسلة الملفات CSPro.

              +

              للجدولة والتحليل تم استخدام الإصدار 10.0 و 14.0 من SPSS. تم استخدام الإصدار 10.0 في الأصل لجميع برامج الجدولة ، باستثناء وفيات الأطفال. إصدار لاحق بعد نقل جميع الملفات إلى SPSS ، تم إعادة ترميز بعض المتغيرات لاستخدامها كخصائص أساسية في جدولة البيانات ، بما في ذلك تصنيف العمر والتعليم والمناطق الجغرافية حسب الحاجة للتحليل. في عملية إعادة ترميز الأعمار والتواريخ ، تم إجراء بعض التضمين العشوائي للتواريخ (ضمن قيود محسوبة) للتعامل مع الأعمار أو التواريخ المفقودة أو "لا أعرف". بالإضافة إلى ذلك ، تم حساب مؤشر الثروة (الأصول) لأفراد الأسرة باستخدام تحليل المكونات الرئيسية ، استنادًا إلى أصول الأسرة ، وتم تضمين كل من النتيجة والخُمس في مجموعات البيانات لاستخدامها في عمليات الجدولة. "; +$lang['EstSmpErr']="

              بالنسبة للمسوح بالعينات ، من الممارسات الجيدة حساب ونشر أخطاء العينات. يستخدم هذا الحقل لتقديم معلومات حول هذه الحسابات. وهذا يشمل: +

                +
              • قائمة النسب / المؤشرات التي تم من أجلها حساب أخطاء أخذ العينات.
              • +
              • التفاصيل المتعلقة بالبرنامج المستخدم لحساب خطأ أخذ العينات ، والإشارة إلى البرامج المستخدمة (يتم توفيرها كموارد خارجية) كبرنامج مستخدم لإجراء العمليات الحسابية. +
              • إشارة إلى التقارير أو أي مستند آخر حيث يمكن العثور على النتائج (يتم توفيرها كموارد خارجية).
              • +
              +

              مثال: +

              تتأثر التقديرات المأخوذة من استطلاع عينة بنوعين من الأخطاء: 1) أخطاء غير متعلقة بأخذ العينات و 2) أخطاء أخذ العينات. الأخطاء غير المتعلقة بأخذ العينات هي نتائج الأخطاء التي ارتكبت في تنفيذ جمع البيانات ومعالجتها. بُذلت جهود عديدة أثناء تنفيذ المسح العنقودي متعدد المؤشرات للفترة 2005-2006 لتقليل هذا النوع من الخطأ ، ومع ذلك ، من المستحيل تجنب الأخطاء غير المتعلقة بأخذ العينات ويصعب تقييمها إحصائيًا. +

              إذا كانت عينة المستجيبين عينة عشوائية بسيطة ، لكان من الممكن استخدام الصيغ المباشرة لحساب أخطاء أخذ العينات. ومع ذلك ، فإن عينة 2005-2006 MICS هي نتيجة لتصميم طبقي متعدد المراحل ، وبالتالي تحتاج إلى استخدام صيغ أكثر تعقيدًا. تم استخدام وحدة العينات المعقدة SPSS لحساب أخطاء أخذ العينات للمسح العنقودي متعدد المؤشرات 2005-2006. تستخدم هذه الوحدة طريقة تايلور الخطية لتقدير التباين لتقديرات المسح التي تكون من الوسائل أو النسب. تم توثيق هذه الطريقة في ملف SPSS CSDescriptives.pdf الموجود ضمن خيارات التعليمات والخوارزميات في SPSS.

              +

              تم حساب أخطاء أخذ العينات لمجموعة مختارة من الإحصائيات (وكلها نسب بسبب قيود طريقة تايلور الخطية) للعينة الوطنية ، والمناطق الحضرية والريفية ، ولكل من المناطق الخمس. لكل إحصائية ، التقدير ، وخطأه المعياري ، ومعامل الاختلاف (أو الخطأ النسبي - النسبة بين الخطأ القياسي والتقدير) ، وتأثير التصميم ، وتأثير تصميم الجذر التربيعي (DEFT - النسبة بين خطأ معياري باستخدام تصميم العينة المحدد والخطأ القياسي الذي سينتج إذا تم استخدام عينة عشوائية بسيطة) ، بالإضافة إلى فواصل الثقة 95 بالمائة (+/- 2 خطأ قياسي). +

              يتم تقديم تفاصيل أخطاء أخذ العينات في ملحق أخطاء العينات بالتقرير وفي جدول أخطاء أخذ العينات المقدم في الموارد الخارجية. "; +$lang['dataAppr']="

              يمكن استخدام هذا القسم للإبلاغ عن أي إجراء آخر تم اتخاذه لتقييم موثوقية البيانات ، أو أي ملاحظات تتعلق بجودة البيانات. يمكن أن يشمل هذا العنصر: +

              +

              هذا مجرد ملخص لشروط استخدام مجموعات البيانات المدرجة في كتالوج بيانات البنك الدولي. يرجى قراءة الاتفاقية الفعلية التي تتحكم في استخدامك لمجموعات البيانات ، +المتاح هنا: شروط استخدام مجموعات البيانات . انظر أيضا + أحكام وشروط البنك الدولي .

              "; + + +/* End of file open_data */ +/* Location: ./application/language/arabic/open_data */ \ No newline at end of file diff --git a/application/language/arabic/permissions_lang.php b/application/language/arabic/permissions_lang.php new file mode 100644 index 000000000..d195df25c --- /dev/null +++ b/application/language/arabic/permissions_lang.php @@ -0,0 +1,23 @@ + -
            • لا يحق إعادة توزيع أو بيع البيانات لأفراد اومؤسسات ، أو المنظمات من غير المرخص لهم دون موافقة خطية من أرشيف البيانات الوطنية.
            • - -
            • وستستخدم هذه البيانات لأغراض البحوث الإحصائية والعلمية فقط. وسيتم استخدامهالإبلاغ المعلومات المجمعة ، وليس من أجل التحقيق في أفراد معينين أو منظمات.
            • -
            • فعلي الباحث الرئيسي تنفيذ تدابير أمنية لمنع نفاذ اشخاص غير مصرح لهم إلى البيانات الجزئية. لا بد من فسخ البيانات الجزئية عند الانتهاء من هذا البحث ، ما لم يوقع إذن كتابي للاحتفاظ بهم مصحوب بضمان أن البيانات محفوضة بطريقة جيدة
            • -
            • يجب ان يعلن الباحث الرئيسي إذا كان يقصد مطابقة البيانات الجزئية المحدودة مع أي مجموعة بيانات أخرى. ويجب تقديم تفاصيل عن مجموعات البيانات وأسباب المطابقة. كما تخضع البيانات التي انشأت لقيود، ويجب أن تمتثل لشروط الاتفاق حول البيانات الاصلية.
            • -
            • أي كتب اومقالات اوأوراق مؤتمرات وأطروحات اورسائل وتقارير ، أو غيرها من المنشورات التي تستخدم البيانات التي تم الحصول عليها من أرشيف البيانات سوف تستشهد بمصدر البيانات وفقا للمتطلبات الاقتباس المنصوص عليها.
            • -
            • ثمة يجب البعث بنسخة إلكترونية من جميع التقارير اوالمنشورات التي استعملت البيانات إلى أرشيف البيانات.
            • -
            • الجامع الأصلي للبيانات ، اوأرشيف البيانات ، اووكالات التمويل ذات الصلة لا تتحمل أية مسؤولية عن استخدام البيانات أو للتفسيرات أو الاستنتاجات المستخلصة من طرف المستخدم.
            • -
                - -

                من خلال استمراركم بعد هذه النقطة في عملية النفاذ الى البيانات، تتعهدون بالامتثال للشروط المذكورة أعلاه و تتعهدون باستخدام البيانات الإحصائية التي تم الحصول عليها وفقا للمعايير القانونية التي تهدف إلى حماية سرية الأفراد.

                - -"; -$lang['public_use_files']=" ملفات للإستخدام عام -"; - - -/* End of file public_access_terms_lang.php */ -/* Location: ./application/language/arabic/public_access_terms_lang.php */ \ No newline at end of file +$lang['email']="البريد الإلكتروني +"; +$lang['dataset_requested']="مجموعة البيانات المطلوبة"; +$lang['intended_use_of_data']=" الهدف من استخدام البيانات +"; +$lang['describe_your_project']="يرجى تقديم وصف موجز لمشروعك البحثي (سؤال المشروع ، الأهداف ، الأساليب ، المخرجات المتوقعة ، الشركاء)"; +$lang['i_agree']="أوافق +"; +$lang['terms_and_conditions']="الأحكام والشروط"; +$lang['terms_text_public']="

                  +
                1. لن يتم إعادة توزيع البيانات والمواد الأخرى التي يوفرها أرشيف البيانات الوطني أو بيعها لأفراد أو مؤسسات أو منظمات أخرى دون موافقة كتابية من أرشيف البيانات الوطني.
                2. +
                3. سيتم استخدام البيانات لأغراض البحث الإحصائي والعلمي فقط. سيتم استخدامها فقط للإبلاغ عن المعلومات المجمعة ، وليس للتحقيق مع أفراد أو مؤسسات معينة. +
                4. لن يتم إجراء أي محاولة لإعادة تعريف المستجيبين ، ولن يتم استخدام هوية أي شخص أو مؤسسة يتم اكتشافها عن غير قصد. سيتم الإبلاغ عن أي اكتشاف من هذا القبيل على الفور إلى أرشيف البيانات الوطني. +
                5. لن يتم إجراء أي محاولة لإنتاج روابط بين مجموعات البيانات التي يوفرها أرشيف البيانات الوطني ، أو بين البيانات من أرشيف البيانات الوطني ومجموعات البيانات الأخرى التي يمكن أن تحدد الأفراد أو المنظمات. +
                6. أي كتب أو مقالات أو أوراق مؤتمرات أو أطروحات أو تقارير أو منشورات أخرى تستخدم البيانات التي تم الحصول عليها من أرشيف البيانات الوطني ستشير إلى مصدر البيانات وفقًا لمتطلبات الاقتباس المقدمة مع كل مجموعة بيانات. +
                7. سيتم إرسال نسخة إلكترونية من جميع التقارير والمنشورات بناءً على البيانات المطلوبة إلى أرشيف البيانات الوطني. +
                8. لا يتحمل الجامع الأصلي للبيانات وأرشيف البيانات الوطني ووكالات التمويل ذات الصلة أية مسؤولية عن استخدام البيانات أو التفسيرات أو الاستنتاجات القائمة على هذه الاستخدامات. +
                +

                من خلال الاستمرار في تجاوز هذه النقطة إلى عملية استرداد البيانات ، فإنك تشير إلى موافقتك على الامتثال للشروط والأحكام المذكورة أعلاه وتؤكد لك أن استخدام البيانات الإحصائية التي تم الحصول عليها من أرشيف البيانات الوطني سوف يتوافق مع الشروط المقبولة على نطاق واسع معايير الممارسة والقيود القانونية التي تهدف إلى حماية سرية المستجيبين. "; +$lang['public_use_files']=" ملفات للإستخدام العام PUF +"; +$lang['surveys_in_collection']="المجموعة [s%] تحتوي على المسوح التالية:"; +$lang['collection_data_files']="ملفات الاستخدام العام حسب المجموعة"; +$lang['collection_requested']="طلبات الوصول إلى المجموعة"; +$lang['public_use_data_access_by_collection_message']="لقد تم منحك حق الوصول إلى جميع دراسات الاستخدام العام في المجموعة. يرجى زيارة كل صفحة دراسة لتنزيل ملفات البيانات والوثائق الأخرى."; +$lang['public_use_data_access_by_collection']="تنزيل ملفات البيانات"; +$lang['terms_text_research']="

                  +
                1. لن يتم إعادة توزيع البيانات والمواد الأخرى التي يوفرها أرشيف البيانات الوطني أو بيعها لأفراد أو مؤسسات أو منظمات أخرى دون موافقة كتابية من أرشيف البيانات الوطني.
                2. +
                3. سيتم استخدام البيانات لأغراض البحث الإحصائي والعلمي فقط. سيتم استخدامها فقط للإبلاغ عن المعلومات المجمعة ، وليس للتحقيق مع أفراد أو مؤسسات معينة. +
                4. لن يتم إجراء أي محاولة لإعادة تعريف المستجيبين ، ولن يتم استخدام هوية أي شخص أو مؤسسة يتم اكتشافها عن غير قصد. سيتم الإبلاغ عن أي اكتشاف من هذا القبيل على الفور إلى أرشيف البيانات الوطني. +
                5. لن يتم إجراء أي محاولة لإنتاج روابط بين مجموعات البيانات التي يوفرها أرشيف البيانات الوطني ، أو بين البيانات من أرشيف البيانات الوطني ومجموعات البيانات الأخرى التي يمكن أن تحدد الأفراد أو المنظمات. +
                6. أي كتب أو مقالات أو أوراق مؤتمرات أو أطروحات أو تقارير أو منشورات أخرى تستخدم البيانات التي تم الحصول عليها من أرشيف البيانات الوطني ستشير إلى مصدر البيانات وفقًا لمتطلبات الاقتباس المقدمة مع كل مجموعة بيانات. +
                7. سيتم إرسال نسخة إلكترونية من جميع التقارير والمنشورات بناءً على البيانات المطلوبة إلى أرشيف البيانات الوطني. +
                8. لا يتحمل الجامع الأصلي للبيانات وأرشيف البيانات الوطني ووكالات التمويل ذات الصلة أية مسؤولية عن استخدام البيانات أو التفسيرات أو الاستنتاجات القائمة على هذه الاستخدامات. +
                +

                من خلال الاستمرار في تجاوز هذه النقطة إلى عملية استرداد البيانات ، فإنك تشير إلى موافقتك على الامتثال للشروط والأحكام المذكورة أعلاه وتؤكد لك أن استخدام البيانات الإحصائية التي تم الحصول عليها من أرشيف البيانات الوطني سوف يتوافق مع الشروط المقبولة على نطاق واسع معايير الممارسة والقيود القانونية التي تهدف إلى حماية سرية المستجيبين. "; + + +/* End of file public_access_terms */ +/* Location: ./application/language/arabic/public_access_terms */ \ No newline at end of file diff --git a/application/language/arabic/public_request_lang.php b/application/language/arabic/public_request_lang.php index 35a0ecfe0..3675b5763 100644 --- a/application/language/arabic/public_request_lang.php +++ b/application/language/arabic/public_request_lang.php @@ -1,26 +1,25 @@ + + + عامل التشغيل + المعنى + + + مسافة + بشكل افتراضي ، تشير المسافات بين مصطلحات البحث إلى الكلمة هي +اختياري. إنه يعني أو + + + + + تشير علامة الجمع البادئة إلى AND + + + - + تشير علامة الطرح الأولية إلى NOT + + + () + يتم وضع الأقواس (الأقواس) حول التعبيرات الفرعية لإعطاء +لهم أسبقية أعلى في البحث. + + + * + العلامة النجمية هي عملية القطع. على عكس عوامل التشغيل الأخرى ، يتم إلحاقه بالكلمة (ضع في النهاية) ، أو جزء ، وليس مُضافًا مسبقًا (وضعه في البداية). + + + & quot؛ & quot؛ + علامات الاقتباس المزدوجة في بداية العبارة ونهايتها ، تتطابق فقط مع الصفوف التي تحتوي على العبارة الكاملة ، كما تمت كتابتها. + + + +


                + أمثلة:

                + +
                  +
                • تم إدراج كلمات رئيسية متعددة في حقل مفصول بينها مسافات +ستؤدي إلى نتائج بحث تحتوي على جميع الدراسات التي تلبي أيًا من +المعايير المكتوبة. لذلك ستتم معاملة قائمة الكلمات الرئيسية على أنها أو +بيان . على سبيل المثال: إدراج الجنس والعمر في وصف المتغير سيُظهر جميع الدراسات التي تحتوي على الجنس أو العمر في وصف المتغير.
                  +
                  +
                • +
                • وضع (تقديمًا مسبقًا) علامة + على البداية +من كلمة يعامل البحث على أنه عبارة AND . على سبيل المثال: + الجنس + العمر + الموظف ستقصر النتائج على الدراسات التي تحتوي على جميع العناصر ، الجنس والعمر والموظفون فيها.
                  +
                  +
                • +
                • يؤدي وضع علامة - على بداية الكلمة (مسبقًا) إلى معاملة البحث على أنه عبارة NOT. على سبيل المثال: + Gender + Age + Employed -كينيا ستقصر النتائج على الدراسات التي تحتوي على جميع العناصر الجنس والعمر والموظفون ، لكنها تستبعد النتائج الخاصة بكينيا من النتائج.
                  +
                  +
                • +
                • سيؤدي وضع علامات الاقتباس & quot؛ & quot؛ حول مصطلح البحث إلى تقييم المصطلح كمصطلح واحد. على سبيل المثال: لقصر البحث على أوصاف الدراسة التي تحتوي على التسلسل الدقيق للكلمات دراسة صحية ، يمكنك كتابة & quot؛ دراسة صحية & quot؛ بين علامات الاقتباس. بدون علامات الاقتباس ، سيُظهر البحث جميع الدراسات المتعلقة بالصحة أو الدراسة فيها. باستخدام علامتي الاقتباس ، لن يتم عرض سوى الدراسات ذات الصياغة الدقيقة في التسلسل دراسة صحية .
                  +
                  +
                • +
                • يُسمح باستبدال الأحرف في الكلمات أو العبارات بعلامة النجمة * بدل. على سبيل المثال ، قد يؤدي البحث عن الحرارة * إلى نتائج التدفئة والتدفئة والتدفئة.
                  +
                  +
                • +
                • البدل ؟ يمكن أن تستخدم أيضًا في عمليات البحث كبديل للأحرف. على سبيل المثال: البحث عن توظيف؟ سيؤدي إلى نتائج للتوظيف أو التوظيف.
                  +
                  +
                • +
                "; + + +/* End of file search_help */ +/* Location: ./application/language/arabic/search_help */ \ No newline at end of file diff --git a/application/language/arabic/site_menu_lang.php b/application/language/arabic/site_menu_lang.php new file mode 100644 index 000000000..92104cc89 --- /dev/null +++ b/application/language/arabic/site_menu_lang.php @@ -0,0 +1,31 @@ +%s . لاستكمال التسجيل وتنشيط حسابك الرجاء الدخول على العنوان التالي (URL): "; -$lang['your_account_details']="هذه تفاصيل حسابك"; -$lang['do_not_reply_to_this_email']="الرجاءعدم الرد على هذه الرسالة"; +$lang['new_user_registration_received']="تم استلام تسجيل مستخدم جديد. تفاصيل المستخدم هي:"; +$lang['thank_you_for_registration']="شكرا لتسجيلكم علي الموقع %s . لاستكمال التسجيل وتنشيط حسابك الرجاء الدخول على العنوان التالي (URL): "; +$lang['your_account_details']="تفاصيل حسابك هي"; +$lang['do_not_reply_to_this_email']="الرجاءعدم الرد على هذه الايميل"; $lang['click_url_to_reset_password']="لإستعادة كلمة المرور ، انقر على الرابط أدناه أو افتح هذا الرابط في نافذة جديدة."; $lang['request_password_ignore']="إذا لم تطلب إعادة تعيين كلمة السر ، تجاهل هذه الرسالة."; $lang['enter_email_to_reset_password']="الرجاء إدخال عنوان البريد الإلكتروني الخاص بك. وسوف نرسل لك رسالة لإعادة تعيين كلمة السر."; -$lang['password_is_sent']="تم إعادة تعيين كلمة السر الخاصة بك وكلمة السر الجديدة ارسلت إليك عبر البريد الإلكتروني."; +$lang['password_is_sent']="تمت إعادة تعيين كلمة المرور الخاصة بك وإرسال كلمة مرور جديدة إلى عنوان بريدك الإلكتروني."; $lang['login_with_new_password']="اتقر هنا لتسجيل الدخول باستخدام كلمة السر الجديدة."; -$lang['message_sent_to_your_email']="أرسلت لك رسالة علي عنوان بريدك الإلكتروني. يرجى قراءة رسائلك."; -$lang['password_reset_to']="تم تغيير كلمة السرالخاصة بك الي %s. للدخول علي الموقع هذه المعطيات الخاصة بك:"; +$lang['message_sent_to_your_email']="تم إرسال رسالة بريد إلكتروني إلى عنوان بريدك الإلكتروني ، يرجى التحقق من صندوق الوارد الخاص بك."; +$lang['password_reset_to']="تم تغيير كلمة السرالخاصة بك الى %s. للدخول الى الموقع هذه المعطيات الخاصة بك:"; $lang['forgot_password_verification']="نسيت كلمة السر -- التحقق"; $lang['account_activation']="تنشيط الحساب"; -$lang['callback_country_invalid']="يتوجب وضع اسم البلد"; -$lang['openid_url']="ع رض رابط -"; - - -/* End of file users_lang.php */ -/* Location: ./application/language/arabic/users_lang.php */ \ No newline at end of file +$lang['callback_country_invalid']="حقل البلد مطلوب."; +$lang['log_in']="دخول"; +$lang['site_login_privacy_terms']="سيتم استخدام المعلومات التي تقدمها بالتسجيل أو تسجيل الدخول إلى الكتالوج الخاص بنا وفقًا لشروط سياسة الخصوصية الخاصة بـ NSO."; +$lang['impersonate_user']="انتحال صفة مستخدم آخر"; +$lang['impersonate_msg']="حدد الحساب أدناه لانتحال صفة"; +$lang['general_user_accounts']="حسابات المستخدمين العامة (لا يوجد وصول مسؤول)"; +$lang['general_user_accounts_description']="مستخدمو الموقع العام الذين ليس لديهم حق الوصول إلى إدارة الموقع"; +$lang['edit_user_permissions']="تحرير أذونات المستخدم"; +$lang['site_admin_accounts']="مسؤولو الموقع (صلاحيات كاملة)"; +$lang['site_admin_accounts_description']="السيطرة الكاملة على جميع أقسام الموقع"; +$lang['site_admin_limited_accounts']="مسؤولو الموقع (صلاحيات محدودة)"; +$lang['site_admin_limited_accounts_description']="تقييد وصول المستخدم إلى إدارة الموقع وأذونات التحكم لكل مجموعة للمستخدم"; +$lang['user_site_level_permissions']="أذونات على مستوى الموقع"; +$lang['assigned_user_groups']="أدوار المستخدم العالمية"; +$lang['manage_permissions']="إدارة الأذونات/الصلاحيات"; +$lang['permissions_per_collection']="أذونات لكل مجموعة"; +$lang['reset_password']="اعادة ضبط كلمه السر"; +$lang['api_keys']="مفاتيح API"; +$lang['no_api_keys_found']="لم يتم العثور على مفاتيح API."; +$lang['generate_api_key']="توليد/إنشاء مفتاح API"; + + +/* End of file users */ +/* Location: ./application/language/arabic/users */ \ No newline at end of file diff --git a/application/language/arabic/vocabularies_lang.php b/application/language/arabic/vocabularies_lang.php index e7cef4448..991b2036d 100644 --- a/application/language/arabic/vocabularies_lang.php +++ b/application/language/arabic/vocabularies_lang.php @@ -3,14 +3,14 @@ $lang['vocabulary']="مفردات"; $lang['term']="المصطلح"; $lang['terms']="المصطلحات"; -$lang['edit_vocabulary']="تعديل المفردات"; -$lang['add_vocabulary']="اضافة مفرد"; +$lang['edit_vocabulary']="تعديل/تحرير المفردات"; +$lang['add_vocabulary']="إضافة مفردات"; $lang['home']="الصفحة الرئيسية"; -$lang['add_term']="اضافة مصطلح"; +$lang['add_term']="إضافة مصطلح"; $lang['edit_term']="تعديل مصطلح"; $lang['select_term_parent']="حدد أصل المصطلح"; $lang['title_terms']="المصطلحات"; - - -/* End of file vocabularies_lang.php */ -/* Location: ./application/language/arabic/vocabularies_lang.php */ \ No newline at end of file + + +/* End of file vocabularies */ +/* Location: ./application/language/arabic/vocabularies */ \ No newline at end of file From d961e84da388eb44ad1c074b82de7f1e486e11d2 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Tue, 8 Feb 2022 12:47:03 +0500 Subject: [PATCH 04/79] Enable facets for regions --- application/controllers/Catalog.php | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/application/controllers/Catalog.php b/application/controllers/Catalog.php index e56e2f2a6..fe0743f1a 100644 --- a/application/controllers/Catalog.php +++ b/application/controllers/Catalog.php @@ -111,6 +111,12 @@ private function load_facets_data($active_tab=null) $this->input->get("collection") ); + $this->facets['regions']=$this->Search_helper_model->get_active_regions( + $repo_id, + $this->active_tab, + $this->input->get("region") + ); + $this->facets['da_types']=$this->Search_helper_model->get_active_data_types( $repo_id, $this->active_tab, @@ -191,6 +197,14 @@ private function load_facets_html() ),true); } + //regions + $filters['regions']=$this->load->view('search/facet', + array( + 'items'=>$this->facets['regions'], + 'filter_id'=>'region', + 'is_enabled'=>$this->is_facet_enabled($this->active_tab,'region') + ),true); + //data classifications $filters['data_class']=$this->load->view('search/facet', array( @@ -372,6 +386,7 @@ function _search() $search_options->sk =trim(xss_clean($this->input->get("sk"))); $search_options->vf =xss_clean($this->input->get("vf")); $search_options->country =xss_clean($this->input->get("country")); + $search_options->region =xss_clean($this->input->get("region")); $search_options->view =xss_clean($this->input->get("view")); $search_options->image_view =xss_clean($this->input->get("image_view")); $search_options->topic =xss_clean($this->input->get("topic")); @@ -446,6 +461,7 @@ function _search() //'variable_keywords'=>$search_options->vk, 'variable_fields'=>$search_options->vf, 'countries'=>$search_options->country, + 'regions'=>$search_options->region, 'from'=>$search_options->from, 'to'=>$search_options->to, 'tags'=>$search_options->tag, @@ -480,6 +496,7 @@ function _search() $data['search_options']=$search_options; $data['data_access_types']=$this->facets['da_types'];//$this->Form_model->get_form_list(); $data['data_classifications']=$this->facets['data_class'];//$this->Data_classification_model->get_list(); + $data['regions']=$this->facets['regions']; $data['sid']=$search_options->sid; //show featured only if no filters or search From 9cad7574ac3c0f16ac1ad086167d457484e25872 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Thu, 10 Feb 2022 14:40:55 +0500 Subject: [PATCH 05/79] minor --- application/controllers/Catalog.php | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/application/controllers/Catalog.php b/application/controllers/Catalog.php index fe0743f1a..63183ad80 100644 --- a/application/controllers/Catalog.php +++ b/application/controllers/Catalog.php @@ -111,11 +111,14 @@ private function load_facets_data($active_tab=null) $this->input->get("collection") ); - $this->facets['regions']=$this->Search_helper_model->get_active_regions( - $repo_id, - $this->active_tab, - $this->input->get("region") - ); + $this->facets['regions']=array(); + if ($this->is_facet_enabled($this->active_tab,'region')){ + $this->facets['regions']=$this->Search_helper_model->get_active_regions( + $repo_id, + $this->active_tab, + $this->input->get("region") + ); + } $this->facets['da_types']=$this->Search_helper_model->get_active_data_types( $repo_id, From 282504da860c36980738adbc492291a98bfec954 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Thu, 10 Feb 2022 15:25:27 +0500 Subject: [PATCH 06/79] Update document schema with fields annote, booktitle, crossref, howpublished, key, organization, url --- .../catalog-admin/document-schema.json | 76 +++++++++++++++---- application/schemas/document-schema.json | 76 +++++++++++++++---- 2 files changed, 124 insertions(+), 28 deletions(-) diff --git a/api-documentation/catalog-admin/document-schema.json b/api-documentation/catalog-admin/document-schema.json index 7688f13f0..179ac6394 100644 --- a/api-documentation/catalog-admin/document-schema.json +++ b/api-documentation/catalog-admin/document-schema.json @@ -518,12 +518,18 @@ "volume": { "type": "string", "title": "Volume number", - "description":"Volume number" + "description":"Volume number" }, "issue": { "type": "string", "title": "Issue number", - "description":"Issue number" + "description":"Issue number" + }, + + "number": { + "type": "string", + "title": "Number", + "description":"The number of a journal, magazine, technical report, or of a work in a series. An issue of a journal or magazine is usually identified by its volume and number; the organization that issues a technical report usually gives it a number; and sometimes books are given numbers in a named series." }, "pages": { @@ -536,6 +542,60 @@ "title": "Series name", "description":"The name given to a series or set of books. When citing an entire book, the title field gives its title and the optional series field gives the name of a series in which the book was published." }, + + "publisher": { + "type": "string", + "title": "Publisher", + "description":"Entity responsible for making the resource available" + }, + + "publisher_address": { + "type": "string", + "title":"Publisher's address", + "description": "For major publishing houses, just the city is given. For small publishers, you can help the reader by giving the complete address." + }, + + "annote": { + "type": "string", + "title": "Annotation", + "description":"For annotation, element will not be used by standard bibliography styles like the MLA, APA or Chicago, but may be used by others that produce an annotated bibliography." + }, + + "booktitle": { + "type": "string", + "title": "Book title", + "description":"Title of a book, part of which is being cited" + }, + + "crossref": { + "type": "string", + "title": "Book title", + "description":"The database key of the entry being cross referenced" + }, + + "howpublished": { + "type": "string", + "title": "Store the notice for unusual publications", + "description":"The element is used to store the notice for unusual publications. The first word should be capitalized. For example, `WebPage`, or `Distributed at the local tourist office`" + }, + + "key": { + "type": "string", + "title": "Key", + "description":"A key is a field used for alphabetizing, cross referencing, and creating a label when the `author' information is missing" + }, + + "organization": { + "type": "string", + "title": "Organization", + "description":"The organization that sponsors a conference or that publishes a manual" + }, + + "url": { + "type": "string", + "title": "URL", + "description":"URL of the document, preferably a permanent URL" + }, "translators": { "type": "array", @@ -642,18 +702,6 @@ ] }, - "publisher": { - "type": "string", - "title": "Publisher", - "description":"Entity responsible for making the resource available" - }, - - "publisher_address": { - "type": "string", - "title":"Publisher's address", - "description": "For major publishing houses, just the city is given. For small publishers, you can help the reader by giving the complete address." - }, - "rights": { "type": "string", "title": "Rights", diff --git a/application/schemas/document-schema.json b/application/schemas/document-schema.json index 7688f13f0..179ac6394 100644 --- a/application/schemas/document-schema.json +++ b/application/schemas/document-schema.json @@ -518,12 +518,18 @@ "volume": { "type": "string", "title": "Volume number", - "description":"Volume number" + "description":"Volume number" }, "issue": { "type": "string", "title": "Issue number", - "description":"Issue number" + "description":"Issue number" + }, + + "number": { + "type": "string", + "title": "Number", + "description":"The number of a journal, magazine, technical report, or of a work in a series. An issue of a journal or magazine is usually identified by its volume and number; the organization that issues a technical report usually gives it a number; and sometimes books are given numbers in a named series." }, "pages": { @@ -536,6 +542,60 @@ "title": "Series name", "description":"The name given to a series or set of books. When citing an entire book, the title field gives its title and the optional series field gives the name of a series in which the book was published." }, + + "publisher": { + "type": "string", + "title": "Publisher", + "description":"Entity responsible for making the resource available" + }, + + "publisher_address": { + "type": "string", + "title":"Publisher's address", + "description": "For major publishing houses, just the city is given. For small publishers, you can help the reader by giving the complete address." + }, + + "annote": { + "type": "string", + "title": "Annotation", + "description":"For annotation, element will not be used by standard bibliography styles like the MLA, APA or Chicago, but may be used by others that produce an annotated bibliography." + }, + + "booktitle": { + "type": "string", + "title": "Book title", + "description":"Title of a book, part of which is being cited" + }, + + "crossref": { + "type": "string", + "title": "Book title", + "description":"The database key of the entry being cross referenced" + }, + + "howpublished": { + "type": "string", + "title": "Store the notice for unusual publications", + "description":"The element is used to store the notice for unusual publications. The first word should be capitalized. For example, `WebPage`, or `Distributed at the local tourist office`" + }, + + "key": { + "type": "string", + "title": "Key", + "description":"A key is a field used for alphabetizing, cross referencing, and creating a label when the `author' information is missing" + }, + + "organization": { + "type": "string", + "title": "Organization", + "description":"The organization that sponsors a conference or that publishes a manual" + }, + + "url": { + "type": "string", + "title": "URL", + "description":"URL of the document, preferably a permanent URL" + }, "translators": { "type": "array", @@ -642,18 +702,6 @@ ] }, - "publisher": { - "type": "string", - "title": "Publisher", - "description":"Entity responsible for making the resource available" - }, - - "publisher_address": { - "type": "string", - "title":"Publisher's address", - "description": "For major publishing houses, just the city is given. For small publishers, you can help the reader by giving the complete address." - }, - "rights": { "type": "string", "title": "Rights", From 3ee9b655f6d8aecd144a6337757044c61bd4fe42 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Thu, 10 Feb 2022 16:11:04 +0500 Subject: [PATCH 07/79] Update ddi/microdata schema --- .../catalog-admin/ddi-schema.json | 107 +++++++++++------- application/schemas/ddi-schema.json | 107 +++++++++++------- 2 files changed, 138 insertions(+), 76 deletions(-) diff --git a/api-documentation/catalog-admin/ddi-schema.json b/api-documentation/catalog-admin/ddi-schema.json index d485bff95..57783b4b5 100644 --- a/api-documentation/catalog-admin/ddi-schema.json +++ b/api-documentation/catalog-admin/ddi-schema.json @@ -322,6 +322,10 @@ "affiliation":{ "title":"Affiliation", "type":"string" + }, + "uri":{ + "title":"URI", + "type":"string" } }, "required":[ @@ -348,6 +352,10 @@ "email":{ "title":"Email", "type":"string" + }, + "uri":{ + "title":"URI", + "type":"string" } } }, @@ -374,6 +382,10 @@ "affiliation":{ "title":"Affiliation", "type":"string" + }, + "uri":{ + "title":"URI", + "type":"string" } } }, @@ -1287,54 +1299,73 @@ "study_class":{ "title":"Class of the Study", "description":"Generally used to give the data archive's class or study status number, which indicates the processing status of the study. May also be used as a text field to describe processing status. Example: `DDA Class C`, `Study is available from http://example.com` ", - "type":"string", + "type":["string","array"], "_ddi_xpath":"stdyDscr/method/stdyClas" }, + "data_processing":{ - "type":"string", + "type":"array", "title":"Data Processing", "description":"Describes various data processing procedures not captured elsewhere in the documentation, such as topcoding, recoding, suppression, tabulation, etc. The `type` attribute supports better classification of this activity, including the optional use of a controlled vocabulary", - "_ddi_xpath":"stdyDscr/method/dataProcessing" - }, - "data_processing_type":{ - "type":"string", - "title":"Data Processing type", - "description":"Data procssing type", - "_ddi_xpath":"stdyDscr/method/dataProcessing/@type" + "_ddi_xpath":"stdyDscr/method/dataProcessing", + "items":{ + "type":"object", + "properties":{ + "data_processing":{ + "title":"Data processing", + "type":"string" + }, + "source":{ + "title":"Source", + "type":"string" + }, + "type":{ + "title":"Data processing type", + "type":"string" + } + }, + "required":[ + "data_processing" + ] + } }, + "coding_instructions":{ - "type":"object", + "type":"array", "title":"Coding Instructions", "_ddi_xpath":"stdyDscr/method/codingInstructions", "description":"Describe specific coding instructions used in data processing, cleaning, assession, or tabulation.", - "properties":{ - "related_processes":{ - "title":"Related processes", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/@relatedProcesses" - }, - "type":{ - "title":"Coding instructions type", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/@type" - }, - "txt":{ - "title":"Coding instructions text", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/txt" - }, - "command":{ - "title":"Command", - "description":"Provide command code for the coding instruction. The formalLanguage attribute identifies the language of the command code.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/command" - }, - "command_language":{ - "title":"Language of the command code", - "description":"Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/command/@formalLanguage" - } + "items":{ + "type":"object", + "properties":{ + "related_processes":{ + "title":"Related processes", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/@relatedProcesses" + }, + "type":{ + "title":"Coding instructions type", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/@type" + }, + "txt":{ + "title":"Coding instructions text", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/txt" + }, + "command":{ + "title":"Command", + "description":"Provide command code for the coding instruction. The formalLanguage attribute identifies the language of the command code.", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/command" + }, + "command_language":{ + "title":"Language of the command code", + "description":"Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/command/@formalLanguage" + } + } } } } diff --git a/application/schemas/ddi-schema.json b/application/schemas/ddi-schema.json index d485bff95..57783b4b5 100644 --- a/application/schemas/ddi-schema.json +++ b/application/schemas/ddi-schema.json @@ -322,6 +322,10 @@ "affiliation":{ "title":"Affiliation", "type":"string" + }, + "uri":{ + "title":"URI", + "type":"string" } }, "required":[ @@ -348,6 +352,10 @@ "email":{ "title":"Email", "type":"string" + }, + "uri":{ + "title":"URI", + "type":"string" } } }, @@ -374,6 +382,10 @@ "affiliation":{ "title":"Affiliation", "type":"string" + }, + "uri":{ + "title":"URI", + "type":"string" } } }, @@ -1287,54 +1299,73 @@ "study_class":{ "title":"Class of the Study", "description":"Generally used to give the data archive's class or study status number, which indicates the processing status of the study. May also be used as a text field to describe processing status. Example: `DDA Class C`, `Study is available from http://example.com` ", - "type":"string", + "type":["string","array"], "_ddi_xpath":"stdyDscr/method/stdyClas" }, + "data_processing":{ - "type":"string", + "type":"array", "title":"Data Processing", "description":"Describes various data processing procedures not captured elsewhere in the documentation, such as topcoding, recoding, suppression, tabulation, etc. The `type` attribute supports better classification of this activity, including the optional use of a controlled vocabulary", - "_ddi_xpath":"stdyDscr/method/dataProcessing" - }, - "data_processing_type":{ - "type":"string", - "title":"Data Processing type", - "description":"Data procssing type", - "_ddi_xpath":"stdyDscr/method/dataProcessing/@type" + "_ddi_xpath":"stdyDscr/method/dataProcessing", + "items":{ + "type":"object", + "properties":{ + "data_processing":{ + "title":"Data processing", + "type":"string" + }, + "source":{ + "title":"Source", + "type":"string" + }, + "type":{ + "title":"Data processing type", + "type":"string" + } + }, + "required":[ + "data_processing" + ] + } }, + "coding_instructions":{ - "type":"object", + "type":"array", "title":"Coding Instructions", "_ddi_xpath":"stdyDscr/method/codingInstructions", "description":"Describe specific coding instructions used in data processing, cleaning, assession, or tabulation.", - "properties":{ - "related_processes":{ - "title":"Related processes", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/@relatedProcesses" - }, - "type":{ - "title":"Coding instructions type", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/@type" - }, - "txt":{ - "title":"Coding instructions text", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/txt" - }, - "command":{ - "title":"Command", - "description":"Provide command code for the coding instruction. The formalLanguage attribute identifies the language of the command code.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/command" - }, - "command_language":{ - "title":"Language of the command code", - "description":"Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/command/@formalLanguage" - } + "items":{ + "type":"object", + "properties":{ + "related_processes":{ + "title":"Related processes", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/@relatedProcesses" + }, + "type":{ + "title":"Coding instructions type", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/@type" + }, + "txt":{ + "title":"Coding instructions text", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/txt" + }, + "command":{ + "title":"Command", + "description":"Provide command code for the coding instruction. The formalLanguage attribute identifies the language of the command code.", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/command" + }, + "command_language":{ + "title":"Language of the command code", + "description":"Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", + "type":"string", + "_ddi_xpath":"stdyDscr/method/codingInstructions/command/@formalLanguage" + } + } } } } From c5007c52ea5c676dd5a466a31b2ef402f95756b8 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Thu, 10 Feb 2022 19:04:42 +0500 Subject: [PATCH 08/79] remove field 'issue' --- api-documentation/catalog-admin/document-schema.json | 7 +------ application/schemas/document-schema.json | 7 +------ 2 files changed, 2 insertions(+), 12 deletions(-) diff --git a/api-documentation/catalog-admin/document-schema.json b/api-documentation/catalog-admin/document-schema.json index 179ac6394..20d14dd4d 100644 --- a/api-documentation/catalog-admin/document-schema.json +++ b/api-documentation/catalog-admin/document-schema.json @@ -519,12 +519,7 @@ "type": "string", "title": "Volume number", "description":"Volume number" - }, - "issue": { - "type": "string", - "title": "Issue number", - "description":"Issue number" - }, + }, "number": { "type": "string", diff --git a/application/schemas/document-schema.json b/application/schemas/document-schema.json index 179ac6394..20d14dd4d 100644 --- a/application/schemas/document-schema.json +++ b/application/schemas/document-schema.json @@ -519,12 +519,7 @@ "type": "string", "title": "Volume number", "description":"Volume number" - }, - "issue": { - "type": "string", - "title": "Issue number", - "description":"Issue number" - }, + }, "number": { "type": "string", From 77ffa87217c13538dda45256ac7b37676f9db997 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Fri, 11 Feb 2022 18:24:50 +0500 Subject: [PATCH 09/79] misc microdata schema updates --- .../catalog-admin/ddi-schema.json | 2545 +++++++++-------- application/schemas/ddi-schema.json | 2545 +++++++++-------- 2 files changed, 2558 insertions(+), 2532 deletions(-) diff --git a/api-documentation/catalog-admin/ddi-schema.json b/api-documentation/catalog-admin/ddi-schema.json index 57783b4b5..c3dfa6cfb 100644 --- a/api-documentation/catalog-admin/ddi-schema.json +++ b/api-documentation/catalog-admin/ddi-schema.json @@ -1,782 +1,781 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "http://ihsn.org/schemas/ddi2-codebook", - "version":"0.0", - "title":"Survey Microdata Schema Draft", - "description":"Schema for Survey data type based on DDI 2.5", - "definitions":{ - "doc_desc":{ - "type":"object", - "title":"Document Description", - "description":"Document Description", - "_ddi_xpath":"docDscr", - "properties":{ - "title":{ - "title":"Document title", - "description":"Document title", - "type":"string", - "_ddi_xpath":"docDscr/citation/titlStmt/titl" + "version": "0.0", + "title": "Survey Microdata Schema Draft", + "description": "Schema for Survey data type based on DDI 2.5", + "definitions": { + "doc_desc": { + "type": "object", + "title": "Document Description", + "description": "Document Description", + "_ddi_xpath": "docDscr", + "properties": { + "title": { + "title": "Document title", + "description": "Document title", + "type": "string", + "_ddi_xpath": "docDscr/citation/titlStmt/titl" }, - "idno":{ - "title":"Unique ID number for the document", - "type":"string", - "_ddi_xpath":"docDscr/citation/titlStmt/IDNo" + "idno": { + "title": "Unique ID number for the document", + "type": "string", + "_ddi_xpath": "docDscr/citation/titlStmt/IDNo" }, - "producers":{ - "type":"array", - "title":"Producers", - "description":"List of producers", - "_ddi_xpath":"docDscr/citation/prodStmt/producer", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "description":"Name (required)", - "type":"string" + "producers": { + "type": "array", + "title": "Producers", + "description": "List of producers", + "_ddi_xpath": "docDscr/citation/prodStmt/producer", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Name (required)", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "affiliation":{ - "type":"string", - "title":"Affiliation" + "affiliation": { + "type": "string", + "title": "Affiliation" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "prod_date":{ - "title":"Date of Production", - "description":"Document production date using format(YYYY-MM-DD)", - "type":"string", - "_ddi_xpath":"docDscr/citation/prodStmt/prodDate" + "prod_date": { + "title": "Date of Production", + "description": "Document production date using format(YYYY-MM-DD)", + "type": "string", + "_ddi_xpath": "docDscr/citation/prodStmt/prodDate" }, - "version_statement":{ - "type":"object", - "title":"Version Statement", - "description":"Version Statement", - "_ddi_xpath":"docDscr/citation/verStmt", - "properties":{ - "version":{ - "title":"Version", - "type":"string", - "_ddi_xpath":"docDscr/citation/verStmt/version" + "version_statement": { + "type": "object", + "title": "Version Statement", + "description": "Version Statement", + "_ddi_xpath": "docDscr/citation/verStmt", + "properties": { + "version": { + "title": "Version", + "type": "string", + "_ddi_xpath": "docDscr/citation/verStmt/version" }, - "version_date":{ - "title":"Version Date", - "type":"string", - "_ddi_xpath":"docDscr/citation/verStmt/version/@date" + "version_date": { + "title": "Version Date", + "type": "string", + "_ddi_xpath": "docDscr/citation/verStmt/version/@date" }, - "version_resp":{ - "title":"Version Responsibility Statement", - "description":"The organization or person responsible for the version of the work", - "type":"string", - "_ddi_xpath":"docDscr/citation/verStmt/verResp" + "version_resp": { + "title": "Version Responsibility Statement", + "description": "The organization or person responsible for the version of the work", + "type": "string", + "_ddi_xpath": "docDscr/citation/verStmt/verResp" }, - "version_notes":{ - "title":"Version Notes", - "type":"string", - "_ddi_xpath":"docDscr/citation/verStmt/notes" + "version_notes": { + "title": "Version Notes", + "type": "string", + "_ddi_xpath": "docDscr/citation/verStmt/notes" } } } }, - "additionalProperties":false + "additionalProperties": false }, - "study_desc":{ - "type":"object", - "description":"Study Description", - "_ddi_xpath":"stdyDscr", - "properties":{ - "title_statement":{ - "type":"object", - "description":"Study title", - "_ddi_xpath":"stdyDscr/citation/titlStmt", - "properties":{ - "idno":{ - "type":"string", - "title":"Unique user defined ID", - "description":"The ID number of a dataset is a unique number that is used to identify a particular survey. Define and use a consistent scheme to use. Such an ID could be constructed as follows: country-producer-survey-year-version where \n - country is the 3-letter ISO country abbreviation \n - producer is the abbreviation of the producing agency \n - survey is the survey abbreviation \n - year is the reference year (or the year the survey started) \n - version is the number dataset version number (see Version Description below)", - "_ddi_xpath":"stdyDscr/citation/titlStmt/IDNo" + "study_desc": { + "type": "object", + "description": "Study Description", + "_ddi_xpath": "stdyDscr", + "properties": { + "title_statement": { + "type": "object", + "description": "Study title", + "_ddi_xpath": "stdyDscr/citation/titlStmt", + "properties": { + "idno": { + "type": "string", + "title": "Unique user defined ID", + "description": "The ID number of a dataset is a unique number that is used to identify a particular survey. Define and use a consistent scheme to use. Such an ID could be constructed as follows: country-producer-survey-year-version where \n - country is the 3-letter ISO country abbreviation \n - producer is the abbreviation of the producing agency \n - survey is the survey abbreviation \n - year is the reference year (or the year the survey started) \n - version is the number dataset version number (see Version Description below)", + "_ddi_xpath": "stdyDscr/citation/titlStmt/IDNo" }, - "identifiers":{ - "type":"array", - "title":"Other identifiers", - "description":"Other identifiers", - "items":{ - "type":"object", - "properties":{ - "type":{ - "title":"Identifier type", - "description":"Type of identifier e.g. `doi`, `handle`, `other`", - "type":"string" + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" }, - "identifier":{ - "title":"Identifier", - "type":"string" + "identifier": { + "title": "Identifier", + "type": "string" } }, - "required":[ + "required": [ "identifier" ] } }, - - "title":{ - "type":"string", - "title":"Survey title", - "description":"The title is the official name of the survey as it is stated on the questionnaire or as it appears in the design documents. The following items should be noted:\n - Include the reference year(s) of the survey in the title. \n - Do not include the abbreviation of the survey name in the title. \n - As the survey title is a proper noun, the first letter of each word should be capitalized (except for prepositions or other conjunctions).\n - Including the country name in the title is optional.", - "_ddi_xpath":"stdyDscr/citation/titlStmt/titl" + "title": { + "type": "string", + "title": "Survey title", + "description": "The title is the official name of the survey as it is stated on the questionnaire or as it appears in the design documents. The following items should be noted:\n - Include the reference year(s) of the survey in the title. \n - Do not include the abbreviation of the survey name in the title. \n - As the survey title is a proper noun, the first letter of each word should be capitalized (except for prepositions or other conjunctions).\n - Including the country name in the title is optional.", + "_ddi_xpath": "stdyDscr/citation/titlStmt/titl" }, - "sub_title":{ - "type":"string", - "title":"Survey subtitle", - "description":"A short subtitle for the survey", - "_ddi_xpath":"stdyDscr/citation/titlStmt/subTitl" + "sub_title": { + "type": "string", + "title": "Survey subtitle", + "description": "A short subtitle for the survey", + "_ddi_xpath": "stdyDscr/citation/titlStmt/subTitl" }, - "alternate_title":{ - "type":"string", - "title":"Abbreviation or Acronym", - "description":"The abbreviation of a survey is usually the first letter of each word of the titled survey. The survey reference year(s) may be included.", - "_ddi_xpath":"stdyDscr/citation/titlStmt/altTitl" + "alternate_title": { + "type": "string", + "title": "Abbreviation or Acronym", + "description": "The abbreviation of a survey is usually the first letter of each word of the titled survey. The survey reference year(s) may be included.", + "_ddi_xpath": "stdyDscr/citation/titlStmt/altTitl" }, - "translated_title":{ - "title":"Translated Title", - "description":"In countries with more than one official language, a translation of the title may be provided.", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/titlStmt/parTitl" + "translated_title": { + "title": "Translated Title", + "description": "In countries with more than one official language, a translation of the title may be provided.", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/titlStmt/parTitl" } }, - "required":[ + "required": [ "idno", "title" ] }, - "authoring_entity":{ - "type":"array", - "title":"Authoring entity/Primary investigators", - "description":"The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", - "_ddi_xpath":"stdyDscr/citation/rspStmt/AuthEnty", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Agency Name", - "type":"string" + "authoring_entity": { + "type": "array", + "title": "Authoring entity/Primary investigators", + "description": "The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", + "_ddi_xpath": "stdyDscr/citation/rspStmt/AuthEnty", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Agency Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "oth_id":{ - "type":"array", - "title":"Other Identifications/Acknowledgments", - "description":"Acknowledge any other people and institutions that have in some form contributed to the survey", - "_ddi_xpath":"stdyDscr/citation/rspStmt/othId", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "description":"Person or Agency name", - "type":"string" + "oth_id": { + "type": "array", + "title": "Other Identifications/Acknowledgments", + "description": "Acknowledge any other people and institutions that have in some form contributed to the survey", + "_ddi_xpath": "stdyDscr/citation/rspStmt/othId", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Person or Agency name", + "type": "string" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "production_statement":{ - "type":"object", - "title":"Production Statement", - "description":"Production Statement", - "_ddi_xpath":"stdyDscr/citation/prodStmt", - "properties":{ - "producers":{ - "type":"array", - "title":"Producers", - "description":"List of producers", - "_ddi_xpath":"stdyDscr/citation/prodStmt/producer", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "description":"Name (required)", - "type":"string" + "production_statement": { + "type": "object", + "title": "Production Statement", + "description": "Production Statement", + "_ddi_xpath": "stdyDscr/citation/prodStmt", + "properties": { + "producers": { + "type": "array", + "title": "Producers", + "description": "List of producers", + "_ddi_xpath": "stdyDscr/citation/prodStmt/producer", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Name (required)", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "affiliation":{ - "type":"string", - "title":"Affiliation" + "affiliation": { + "type": "string", + "title": "Affiliation" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "copyright":{ - "title":"Copyright", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/prodStmt/copyright" + "copyright": { + "title": "Copyright", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/prodStmt/copyright" }, - "prod_date":{ - "title":"Production Date", - "description":"Date when the marked-up document/marked-up document source/data collection/other material(s) were produced (not distributed or archived). The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute. Production date for data collection (2.1.3.3) maps to Dublin Core Date element.", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/prodStmt/prodDate" + "prod_date": { + "title": "Production Date", + "description": "Date when the marked-up document/marked-up document source/data collection/other material(s) were produced (not distributed or archived). The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute. Production date for data collection (2.1.3.3) maps to Dublin Core Date element.", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/prodStmt/prodDate" }, - "prod_place":{ - "title":"Production Place", - "description":"Address of the archive or organization that produced the work", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/prodStmt/prodPlac" + "prod_place": { + "title": "Production Place", + "description": "Address of the archive or organization that produced the work", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/prodStmt/prodPlac" }, - "funding_agencies":{ - "type":"array", - "title":"Funding Agency/Sponsor", - "description":"The source(s) of funds for production of the work. If different funding agencies sponsored different stages of the production process, use the 'role' attribute to distinguish them.", - "_ddi_xpath":"stdyDscr/citation/prodStmt/fundAg", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Funding Agency/Sponsor", - "type":"string" + "funding_agencies": { + "type": "array", + "title": "Funding Agency/Sponsor", + "description": "The source(s) of funds for production of the work. If different funding agencies sponsored different stages of the production process, use the 'role' attribute to distinguish them.", + "_ddi_xpath": "stdyDscr/citation/prodStmt/fundAg", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Funding Agency/Sponsor", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "grant":{ - "title":"Grant Number", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/prodStmt/grantNo" + "grant": { + "title": "Grant Number", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/prodStmt/grantNo" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" } }, - "required":[ + "required": [ "name" ] } - } + } } }, - "distribution_statement":{ - "type":"object", - "title":"Distribution Statement", - "description":"Distribution Statement", - "_ddi_xpath":"stdyDscr/citation/distStmt", - "properties":{ - "distributors":{ - "type":"array", - "title":"Distributor", - "description":"The organization designated by the author or producer to generate copies of the particular work including any necessary editions or revisions. Names and addresses may be specified and other archives may be co-distributors. A URI attribute is included to provide an URN or URL to the ordering service or download facility on a Web site.", - "_ddi_xpath":"stdyDscr/citation/distStmt/distrbtr", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Organization name", - "description":"Organization name", - "type":"string" + "distribution_statement": { + "type": "object", + "title": "Distribution Statement", + "description": "Distribution Statement", + "_ddi_xpath": "stdyDscr/citation/distStmt", + "properties": { + "distributors": { + "type": "array", + "title": "Distributor", + "description": "The organization designated by the author or producer to generate copies of the particular work including any necessary editions or revisions. Names and addresses may be specified and other archives may be co-distributors. A URI attribute is included to provide an URN or URL to the ordering service or download facility on a Web site.", + "_ddi_xpath": "stdyDscr/citation/distStmt/distrbtr", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Organization name", + "description": "Organization name", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "contact":{ - "type":"array", - "title":"Contact", - "description":"Contact", - "_ddi_xpath":"stdyDscr/citation/distStmt/contact", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "contact": { + "type": "array", + "title": "Contact", + "description": "Contact", + "_ddi_xpath": "stdyDscr/citation/distStmt/contact", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "email":{ - "title":"Email", - "type":"string" + "email": { + "title": "Email", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "depositor":{ - "type":"array", - "title":"Depositor", - "description":"Depositor", - "_ddi_xpath":"stdyDscr/citation/distStmt/depositr", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "depositor": { + "type": "array", + "title": "Depositor", + "description": "Depositor", + "_ddi_xpath": "stdyDscr/citation/distStmt/depositr", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "deposit_date":{ - "title":"Date of Deposit", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/distStmt/depDate" + "deposit_date": { + "title": "Date of Deposit", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/distStmt/depDate" }, - "distribution_date":{ - "title":"Date of Distribution", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/distStmt/distDate" + "distribution_date": { + "title": "Date of Distribution", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/distStmt/distDate" } } }, - "series_statement":{ - "type":"object", - "title":"Series Statement", - "description":"Series Statement", - "_ddi_xpath":"stdyDscr/citation/serStmt", - "properties":{ - "series_name":{ - "title":"Series Name", - "description":"The name of the series to which the work belongs.", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/serStmt/serName" + "series_statement": { + "type": "object", + "title": "Series Statement", + "description": "Series Statement", + "_ddi_xpath": "stdyDscr/citation/serStmt", + "properties": { + "series_name": { + "title": "Series Name", + "description": "The name of the series to which the work belongs.", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/serStmt/serName" }, - "series_info":{ - "title":"Series Information", - "description":"A survey may be repeated at regular intervals (such as an annual labour force survey), or be part of an international survey program (such as the MICS, CWIQ, DHS, LSMS and others). The Series information is a description of this `collection` of surveys. A brief description of the characteristics of the survey, including when it started, how many rounds were already implemented, and who is in charge would be provided here.", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/serStmt/serInfo" + "series_info": { + "title": "Series Information", + "description": "A survey may be repeated at regular intervals (such as an annual labour force survey), or be part of an international survey program (such as the MICS, CWIQ, DHS, LSMS and others). The Series information is a description of this `collection` of surveys. A brief description of the characteristics of the survey, including when it started, how many rounds were already implemented, and who is in charge would be provided here.", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/serStmt/serInfo" } } }, - "version_statement":{ - "type":"object", - "title":"Version Statement", - "description":"Version Statement", - "_ddi_xpath":"stdyDscr/citation/verStmt", - "properties":{ - "version":{ - "title":"Version", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/verStmt/version" + "version_statement": { + "type": "object", + "title": "Version Statement", + "description": "Version Statement", + "_ddi_xpath": "stdyDscr/citation/verStmt", + "properties": { + "version": { + "title": "Version", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/verStmt/version" }, - "version_date":{ - "title":"Version Date", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/verStmt/version/@date" + "version_date": { + "title": "Version Date", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/verStmt/version/@date" }, - "version_resp":{ - "title":"Version Responsibility Statement", - "description":"The organization or person responsible for the version of the work", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/verStmt/verResp" + "version_resp": { + "title": "Version Responsibility Statement", + "description": "The organization or person responsible for the version of the work", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/verStmt/verResp" }, - "version_notes":{ - "title":"Version Notes", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/verStmt/notes" + "version_notes": { + "title": "Version Notes", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/verStmt/notes" } } }, - "bib_citation":{ - "type":"string", - "title":"Bibliographic Citation", - "description":"Complete bibliographic reference containing all of the standard elements of a citation that can be used to cite the work. The `'bib_citation_format'` field is provided to enable specification of the particular citation style used, e.g., APA, MLA, Chicago, etc.", - "_ddi_xpath":"stdyDscr/citation/biblCit" + "bib_citation": { + "type": "string", + "title": "Bibliographic Citation", + "description": "Complete bibliographic reference containing all of the standard elements of a citation that can be used to cite the work. The `'bib_citation_format'` field is provided to enable specification of the particular citation style used, e.g., APA, MLA, Chicago, etc.", + "_ddi_xpath": "stdyDscr/citation/biblCit" }, - "bib_citation_format":{ - "type":"string", - "title":"Bibliographic Citation Format", - "description":"Specification of the particular citation style used, e.g., `APA`, `MLA`, `Chicago`, etc.", - "_ddi_xpath":"stdyDscr/citation/biblCit/@format" + "bib_citation_format": { + "type": "string", + "title": "Bibliographic Citation Format", + "description": "Specification of the particular citation style used, e.g., `APA`, `MLA`, `Chicago`, etc.", + "_ddi_xpath": "stdyDscr/citation/biblCit/@format" }, - "holdings":{ - "type":"array", - "title":"Holdings Information", - "description":"Information concerning either the physical or electronic holdings of the cited work. Attributes include: location--The physical location where a copy is held; callno--The call number for a work at the location specified; and URI--A URN or URL for accessing the electronic copy of the cited work.", - "_ddi_xpath":"stdyDscr/citation/holdings", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "holdings": { + "type": "array", + "title": "Holdings Information", + "description": "Information concerning either the physical or electronic holdings of the cited work. Attributes include: location--The physical location where a copy is held; callno--The call number for a work at the location specified; and URI--A URN or URL for accessing the electronic copy of the cited work.", + "_ddi_xpath": "stdyDscr/citation/holdings", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "location":{ - "title":"Location", - "type":"string" + "location": { + "title": "Location", + "type": "string" }, - "callno":{ - "title":"Callno", - "type":"string" + "callno": { + "title": "Callno", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "study_notes":{ - "title":"Study notes", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/notes" + "study_notes": { + "title": "Study notes", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/notes" }, - "study_authorization":{ - "type":"object", - "title":"Study Authorization", - "_ddi_xpath":"stdyDscr/studyAuthorization", - "description":"Provides structured information on the agency that authorized the study, the date of authorization, and an authorization statement", - "properties":{ - "date":{ - "title":"Authorization Date", - "type":"string", - "_ddi_xpath":"stdyDscr/studyAuthorization/@date" + "study_authorization": { + "type": "object", + "title": "Study Authorization", + "_ddi_xpath": "stdyDscr/studyAuthorization", + "description": "Provides structured information on the agency that authorized the study, the date of authorization, and an authorization statement", + "properties": { + "date": { + "title": "Authorization Date", + "type": "string", + "_ddi_xpath": "stdyDscr/studyAuthorization/@date" }, - "agency":{ - "type":"array", - "title":"Authorizing Agency", - "description":"The source(s) of funds for production of the work. If different funding agencies sponsored different stages of the production process, use the 'role' attribute to distinguish them.", - "_ddi_xpath":"stdyDscr/studyAuthorization/authorizingAgency", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Funding Agency/Sponsor", - "type":"string" + "agency": { + "type": "array", + "title": "Authorizing Agency", + "description": "The source(s) of funds for production of the work. If different funding agencies sponsored different stages of the production process, use the 'role' attribute to distinguish them.", + "_ddi_xpath": "stdyDscr/studyAuthorization/authorizingAgency", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Funding Agency/Sponsor", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "authorization_statement":{ - "title":"Authorization Statement", - "description":"Authorization Statement", - "_ddi_xpath":"stdyDscr/studyAuthorization/authorizationStatement", - "type":"string" + "authorization_statement": { + "title": "Authorization Statement", + "description": "Authorization Statement", + "_ddi_xpath": "stdyDscr/studyAuthorization/authorizationStatement", + "type": "string" } } }, - "study_info":{ - "type":"object", - "title":"Study Scope", - "description":"This section contains information about the data collection's scope across several dimensions, including substantive content, geography, and time.", - "_ddi_xpath":"stdyDscr/stdyInfo", - "properties":{ - "study_budget":{ - "title":"Study Budget", - "description":"Provide a clear summary of the pDescribe the budget of the project in as much detail as needed. Use XHTML structure elements to identify discrete pieces of information in a way that facilitates direct transfer of information on the study budget between DDI 2 and DDI 3 structures.urposes, objectives and content of the survey", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/studyBudget" + "study_info": { + "type": "object", + "title": "Study Scope", + "description": "This section contains information about the data collection's scope across several dimensions, including substantive content, geography, and time.", + "_ddi_xpath": "stdyDscr/stdyInfo", + "properties": { + "study_budget": { + "title": "Study Budget", + "description": "Provide a clear summary of the pDescribe the budget of the project in as much detail as needed. Use XHTML structure elements to identify discrete pieces of information in a way that facilitates direct transfer of information on the study budget between DDI 2 and DDI 3 structures.urposes, objectives and content of the survey", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/studyBudget" }, - "keywords":{ - "type":"array", - "description":"Keywords", - "_ddi_xpath":"stdyDscr/stdyInfo/subject/keywords", - "items":{ - "type":"object", - "properties":{ - "keyword":{ - "title":"Keyword", - "type":"string" + "keywords": { + "type": "array", + "description": "Keywords", + "_ddi_xpath": "stdyDscr/stdyInfo/subject/keywords", + "items": { + "type": "object", + "properties": { + "keyword": { + "title": "Keyword", + "type": "string" }, - "vocab":{ - "title":"Vocabulary", - "type":"string" + "vocab": { + "title": "Vocabulary", + "type": "string" }, - "uri":{ - "title":"uri", - "type":"string" - } + "uri": { + "title": "uri", + "type": "string" + } } } }, - "topics":{ - "type":"array", - "title":"Topic Classification", - "description":"Topic Classification", - "_ddi_xpath":"stdyDscr/stdyInfo/subject/topcClas", - "items":{ - "type":"object", - "properties":{ - "topic":{ - "title":"Topic", - "type":"string" + "topics": { + "type": "array", + "title": "Topic Classification", + "description": "Topic Classification", + "_ddi_xpath": "stdyDscr/stdyInfo/subject/topcClas", + "items": { + "type": "object", + "properties": { + "topic": { + "title": "Topic", + "type": "string" }, - "vocab":{ - "title":"Vocab", - "type":"string" + "vocab": { + "title": "Vocab", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } }, - "required":[ + "required": [ "topic" ] } }, - "abstract":{ - "title":"Abstract", - "description":"Provide a clear summary of the purposes, objectives and content of the survey", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/abstract" + "abstract": { + "title": "Abstract", + "description": "Provide a clear summary of the purposes, objectives and content of the survey", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/abstract" }, - "time_periods":{ - "type":"array", - "title":"Time periods (YYYY/MM/DD)", - "description":"This field will usually be left empty. Time period differs from the dates of collection as they represent the period for which the data collected are applicable or relevant.", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/timePrd", - "items":{ - "type":"object", - "properties":{ - "start":{ - "title":"Start date", - "description":"Start date", - "type":"string" + "time_periods": { + "type": "array", + "title": "Time periods (YYYY/MM/DD)", + "description": "This field will usually be left empty. Time period differs from the dates of collection as they represent the period for which the data collected are applicable or relevant.", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/timePrd", + "items": { + "type": "object", + "properties": { + "start": { + "title": "Start date", + "description": "Start date", + "type": "string" }, - "end":{ - "title":"End date", - "description":"End date", - "type":"string" + "end": { + "title": "End date", + "description": "End date", + "type": "string" }, - "cycle":{ - "title":"Cycle", - "description":"Cycle", - "type":"string" + "cycle": { + "title": "Cycle", + "description": "Cycle", + "type": "string" } }, - "required":[ + "required": [ "start" ] } }, - "coll_dates":{ - "type":"array", - "title":"Dates of Data Collection (YYYY/MM/DD)", - "description":"Enter the dates (at least month and year) of the start and end of the data collection. In some cases, data collection for a same survey can be conducted in waves. In such case, you should enter the start and end date of each wave separately, and identify each wave in the 'cycle' field.", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/collDate", - "items":{ - "type":"object", - "properties":{ - "start":{ - "title":"Start date", - "description":"Start date", - "type":"string" + "coll_dates": { + "type": "array", + "title": "Dates of Data Collection (YYYY/MM/DD)", + "description": "Enter the dates (at least month and year) of the start and end of the data collection. In some cases, data collection for a same survey can be conducted in waves. In such case, you should enter the start and end date of each wave separately, and identify each wave in the 'cycle' field.", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/collDate", + "items": { + "type": "object", + "properties": { + "start": { + "title": "Start date", + "description": "Start date", + "type": "string" }, - "end":{ - "title":"End date", - "description":"End date", - "type":"string" + "end": { + "title": "End date", + "description": "End date", + "type": "string" }, - "cycle":{ - "title":"Cycle", - "description":"Cycle", - "type":"string" + "cycle": { + "title": "Cycle", + "description": "Cycle", + "type": "string" } }, - "required":[ + "required": [ "start" ] } }, - "nation":{ - "title":"Country", - "description":"Indicates the country or countries covered in the file. Field `abbreviation` may be used to list common abbreviations; use of ISO country codes is recommended. Maps to Dublin Core Coverage element. Inclusion of this element is recommended.", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/nation", - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "description":"Country name", - "type":"string" + "nation": { + "title": "Country", + "description": "Indicates the country or countries covered in the file. Field `abbreviation` may be used to list common abbreviations; use of ISO country codes is recommended. Maps to Dublin Core Coverage element. Inclusion of this element is recommended.", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/nation", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Country name", + "type": "string" }, - "abbreviation":{ - "title":"Country code", - "description":"Country ISO code", - "type":"string" + "abbreviation": { + "title": "Country code", + "description": "Country ISO code", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "bbox":{ - "title":"Geographic bounding box", - "type":"array", - "_ddi_xpath":"stdyDscr/sumDscr/geoBndBox", - "items":{ - "type":"object", - "properties":{ - "west":{ - "title":"West", - "type":"string" + "bbox": { + "title": "Geographic bounding box", + "type": "array", + "_ddi_xpath": "stdyDscr/sumDscr/geoBndBox", + "items": { + "type": "object", + "properties": { + "west": { + "title": "West", + "type": "string" }, - "east":{ - "title":"East", - "type":"string" + "east": { + "title": "East", + "type": "string" }, - "south":{ - "title":"South", - "type":"string" + "south": { + "title": "South", + "type": "string" }, - "north":{ - "title":"North", - "type":"string" + "north": { + "title": "North", + "type": "string" } } } }, - "bound_poly":{ - "title":"Geographic Bounding Polygon", - "description":"This field allows the creation of multiple polygons to describe in a more detailed manner the geographic area covered by the dataset. It should only be used to define the outer boundaries of a covered area. For example, in the United States, such polygons can be created to define boundaries for Hawaii, Alaska, and the continental United States, but not interior boundaries for the contiguous states. This field is used to refine a coordinate-based search, not to actually map an area. \nIf the boundPoly element is used, then geoBndBox MUST be present, and all points enclosed by the boundPoly MUST be contained within the geoBndBox. Elements westBL, eastBL, southBL, and northBL of the geoBndBox should each be represented in at least one point of the boundPoly description.", - "type":"array", - "_ddi_xpath":"stdyDscr/sumDscr/boundPoly", - "items":{ - "type":"object", - "properties":{ - "lat":{ - "title":"Latitude", - "description":"Latitude (y coordinate) of a point. Valid range expressed in decimal degrees is as follows: -90,0 to 90,0 degrees (latitude)", - "type":"string" + "bound_poly": { + "title": "Geographic Bounding Polygon", + "description": "This field allows the creation of multiple polygons to describe in a more detailed manner the geographic area covered by the dataset. It should only be used to define the outer boundaries of a covered area. For example, in the United States, such polygons can be created to define boundaries for Hawaii, Alaska, and the continental United States, but not interior boundaries for the contiguous states. This field is used to refine a coordinate-based search, not to actually map an area. \nIf the boundPoly element is used, then geoBndBox MUST be present, and all points enclosed by the boundPoly MUST be contained within the geoBndBox. Elements westBL, eastBL, southBL, and northBL of the geoBndBox should each be represented in at least one point of the boundPoly description.", + "type": "array", + "_ddi_xpath": "stdyDscr/sumDscr/boundPoly", + "items": { + "type": "object", + "properties": { + "lat": { + "title": "Latitude", + "description": "Latitude (y coordinate) of a point. Valid range expressed in decimal degrees is as follows: -90,0 to 90,0 degrees (latitude)", + "type": "string" }, - "lon":{ - "title":"longitude", - "description":"Longitude (x coordinate) of a point. Valid range expressed in decimal degrees is as follows: -180,0 to 180,0 degrees (longitude)", - "type":"string" + "lon": { + "title": "longitude", + "description": "Longitude (x coordinate) of a point. Valid range expressed in decimal degrees is as follows: -180,0 to 180,0 degrees (longitude)", + "type": "string" } } } }, - "geog_coverage":{ - "description":" Information on the geographic coverage of the data. Includes the total geographic scope of the data, and any additional levels of geographic coding provided in the variables. Maps to Dublin Core Coverage element. Inclusion of this element in the codebook is recommended.", - "title":"Geographic Coverage", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/geogCover" + "geog_coverage": { + "description": " Information on the geographic coverage of the data. Includes the total geographic scope of the data, and any additional levels of geographic coding provided in the variables. Maps to Dublin Core Coverage element. Inclusion of this element in the codebook is recommended.", + "title": "Geographic Coverage", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/geogCover" }, - "geog_coverage_notes":{ - "description":"Geographic coverage notes", - "title":"Geographic Coverage notes", - "type":"string", - "_ddi_xpath":"stdyDscr/sumDscr/geogCover/txt" + "geog_coverage_notes": { + "description": "Geographic coverage notes", + "title": "Geographic Coverage notes", + "type": "string", + "_ddi_xpath": "stdyDscr/sumDscr/geogCover/txt" }, - "geog_unit":{ - "title":"Geographic Unit", - "description":"Lowest level of geographic aggregation covered by the data", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/geogUnit" + "geog_unit": { + "title": "Geographic Unit", + "description": "Lowest level of geographic aggregation covered by the data", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/geogUnit" }, - "analysis_unit":{ - "title":"Unit of Analysis", - "description":"Basic unit(s) of analysis or observation that the study describes: individuals, families/households, groups, facilities, institutions/organizations, administrative units, physical locations, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/anlyUnit" + "analysis_unit": { + "title": "Unit of Analysis", + "description": "Basic unit(s) of analysis or observation that the study describes: individuals, families/households, groups, facilities, institutions/organizations, administrative units, physical locations, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/anlyUnit" }, - "universe":{ - "title":"Universe", - "description":"We are interested here in the survey universe (not the universe of particular sections of the questionnaires or variables), i.e. in the identification of the population of interest in the survey. The universe will rarely be the entire population of the country. Sample household surveys, for example, usually do not cover homeless, nomads, diplomats, community households. Some surveys may cover only the population of a particular age group, or only male (or female), etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/universe" + "universe": { + "title": "Universe", + "description": "We are interested here in the survey universe (not the universe of particular sections of the questionnaires or variables), i.e. in the identification of the population of interest in the survey. The universe will rarely be the entire population of the country. Sample household surveys, for example, usually do not cover homeless, nomads, diplomats, community households. Some surveys may cover only the population of a particular age group, or only male (or female), etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/universe" }, - "data_kind":{ - "title":"Kind of Data", - "description":"Broad classification of the data", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/dataKind", - "enum_":[ + "data_kind": { + "title": "Kind of Data", + "description": "Broad classification of the data", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/dataKind", + "enum_": [ "Sample survey data[ssd]", "Census/enumeration data[cen]", "Administrative records data[adm]", @@ -785,383 +784,408 @@ "Observation data/ratings[obs]" ] }, - "notes":{ - "title":"Study notes", - "description":"Study notes", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/notes" + "notes": { + "title": "Study notes", + "description": "Study notes", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/notes" }, - "quality_statement":{ - "title":"Quality Statement", - "description":"This structure consists of two parts, standardsCompliance and otherQualityStatements. In standardsCompliance list all specific standards complied with during the execution of this study. Note the standard name and producer and how the study complied with the standard. Enter any additional quality statements in otherQualityStatements.", - "type":"object", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement", - "_comments":"TODO: not clear if this should be repeatable.", - "properties":{ - "standard_name":{ - "title":"Standard name", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement/standardsCompliance/standard/standardName" - }, - "standard_producer":{ - "title":"Standard producer", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement/standardsCompliance/standard/producer" + "quality_statement": { + "title": "Quality Statement", + "description": "The quality statement provides elements to describe compliance with quality standards in the form of a statement and an itemized list of standards complied with, and an element to provide other quality statement.", + "type": "object", + "_ddi_xpath": "stdyDscr/stdyInfo/qualityStatement", + "_comments": "TODO: not clear if this should be repeatable.", + "properties": { + "compliance_description": { + "title": "Standard compliance description", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/qualityStatement/standardsCompliance/complianceDescription" }, - "standard_compliance_desc":{ - "title":"Standard compliance description", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement/standardsCompliance/complianceDescription" + "standards": { + "type": "array", + "title": "Standards", + "description": "Standards", + "_ddi_xpath": "stdyDscr/stdyInfo/qualityStatement/standardsCompliance/standard", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "producer": { + "title": "Producer", + "type": "string" + } + } + }, + "required": [ + "name" + ] }, - "other_quality_statement":{ - "title":"Other quality statement", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement/otherQualityStatement" + "other_quality_statement": { + "title": "Other quality statement", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/qualityStatement/otherQualityStatement" } } - }, - "ex_post_evaluation":{ - "title":"Ex-Post Evaluation", - "description":"This structure consists of two parts, standardsCompliance and otherQualityStatements. In standardsCompliance list all specific standards complied with during the execution of this study. Note the standard name and producer and how the study complied with the standard. Enter any additional quality statements in otherQualityStatements.", - "type":"object", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation", - "_comments":"TODO: not clear if this should be repeatable.", - "properties":{ - "completion_date":{ - "title":"Evaluation completion date", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation/@completionDate" + }, + "ex_post_evaluation": { + "title": "Ex-Post Evaluation", + "description": "This structure consists of two parts, standardsCompliance and otherQualityStatements. In standardsCompliance list all specific standards complied with during the execution of this study. Note the standard name and producer and how the study complied with the standard. Enter any additional quality statements in otherQualityStatements.", + "type": "object", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation", + "_comments": "TODO: not clear if this should be repeatable.", + "properties": { + "completion_date": { + "title": "Evaluation completion date", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation/@completionDate" }, - "type":{ - "title":"Evaluation type", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/@type" + "type": { + "title": "Evaluation type", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/@type" }, - "evaluator":{ - "type":"array", - "title":"Evaluators", - "description":"Evaluators", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation/evaluator", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Funding Agency/Sponsor", - "type":"string" + "evaluator": { + "type": "array", + "title": "Evaluators", + "description": "Evaluators", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation/evaluator", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Funding Agency/Sponsor", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" - }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "evaluation_process":{ - "title":"Evaluation process", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation/evaluationProcess" + "evaluation_process": { + "title": "Evaluation process", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation/evaluationProcess" }, - "outcomes":{ - "title":"Outcomes", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation/outcomes" + "outcomes": { + "title": "Outcomes", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation/outcomes" } } } }, - "required":[ + "required": [ "nation" ] }, - "study_development":{ - "title":"Study Development", - "description":"Describe the process of study development as a series of development activities. These activities can be typed using a controlled vocabulary. Describe the activity, listing participants with their role and affiliation, resources used (sources of information), and the outcome of the development activity.", - "type":"object", - "_ddi_xpath":"stdyDscr/studyDevelopment", - "properties":{ - "activity_type":{ - "title":"Development activity type", - "type":"string", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/@type" - }, - "activity_description":{ - "title":"Development activity description", - "type":"string", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/description" - }, - "participants":{ - "type":"array", - "title":"Participants", - "description":"Participants", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/participant", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Participant name", - "type":"string" + "study_development": { + "title": "Study Development", + "description": "Describe the process of study development as a series of development activities. These activities can be typed using a controlled vocabulary. Describe the activity, listing participants with their role and affiliation, resources used (sources of information), and the outcome of the development activity.", + "type": "object", + "_ddi_xpath": "stdyDscr/studyDevelopment", + "properties": { + "development_activity": { + "type": "array", + "title": "Development activity", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity", + "items": { + "type": "object", + "properties": { + "activity_type": { + "title": "Development activity type", + "type": "string", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/@type" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "activity_description": { + "title": "Development activity description", + "type": "string", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/description" }, - "role":{ - "title":"Role", - "type":"string" - } - }, - "required":[ - "name" - ] - } - }, - "resource":{ - "type":"object", - "title":"Development activity resource", - "description":"Development activity resource", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource", - "properties":{ - "data_source":{ - "title":"Data source", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource/dataSrc", - "type":"array", - "items":{ - "type":"object", - "properties":{ - "source":{ - "title":"Source", - "type":"string" - } + "participants": { + "type": "array", + "title": "Participants", + "description": "Participants", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/participant", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Participant name", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + } + }, + "required": [ + "name" + ] } + }, + "resources": { + "type": "array", + "title": "Development activity resources", + "description": "Development activity resources", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/resource", + "items":{ + "type":"object", + "properties":{ + "name": { + "type": "string", + "title": "Resource name", + "description": "Name of the resource" + }, + "origin": { + "type": "string", + "title": "Origin of resource", + "description": "For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/resource/srcOrig" + }, + "characteristics": { + "type": "string", + "title": "Characteristics of resource", + "description": "Assessment of characteristics and quality of source material. May not be relevant to survey data.", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/resource/srcChar" + } + } + } + }, + "outcome": { + "title": "Development Activity Outcome", + "description": "Development Activity Outcome", + "type": "string", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/outcome" } - }, - "source_origin":{ - "type":"string", - "title":"Origin of Source", - "description":"For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource/srcOrig" - }, - "source_char":{ - "type":"string", - "title":"Characteristics of Source Noted", - "description":"Assessment of characteristics and quality of source material. May not be relevant to survey data.", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource/srcChar" } } - }, - "outcome":{ - "title":"Development Activity Outcome", - "description":"Development Activity Outcome", - "type":"string", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/outcome" } } }, - "method":{ - "type":"object", - "title":"Methodology and Processing", - "description":"Methodology and processing", - "_ddi_xpath":"stdyDscr/method", - "properties":{ - "data_collection":{ - "type":"object", - "title":"Data Collection", - "_ddi_xpath":"stdyDscr/method/dataColl", - "description":"Information about the methodology employed in a data collection", - "properties":{ - "time_method":{ - "title":"Time Method", - "description":"The time method or time dimension of the data collection. Examples: `panel survey`, `h>cross-section`, `trend study`, `time-series`", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/timeMeth" + "method": { + "type": "object", + "title": "Methodology and Processing", + "description": "Methodology and processing", + "_ddi_xpath": "stdyDscr/method", + "properties": { + "data_collection": { + "type": "object", + "title": "Data Collection", + "_ddi_xpath": "stdyDscr/method/dataColl", + "description": "Information about the methodology employed in a data collection", + "properties": { + "time_method": { + "title": "Time Method", + "description": "The time method or time dimension of the data collection. Examples: `panel survey`, `h>cross-section`, `trend study`, `time-series`", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/timeMeth" }, - "data_collectors":{ - "title":"Data Collectors", - "description":"The persons and/or agencies that took charge of the data collection. This element includes 3 fields: Name, Abbreviation and the Affiliation. In most cases, we will record here the name of the agency, not the name of interviewers. Only in the case of very small-scale surveys, with a very limited number of interviewers, the name of person will be included as well. The field Affiliation is optional and not relevant in all cases.", - "_ddi_xpath":"stdyDscr/method/dataColl/dataCollector", - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "data_collectors": { + "title": "Data Collectors", + "description": "The persons and/or agencies that took charge of the data collection. This element includes 3 fields: Name, Abbreviation and the Affiliation. In most cases, we will record here the name of the agency, not the name of interviewers. Only in the case of very small-scale surveys, with a very limited number of interviewers, the name of person will be included as well. The field Affiliation is optional and not relevant in all cases.", + "_ddi_xpath": "stdyDscr/method/dataColl/dataCollector", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" - }, - "role":{ - "title":"Role", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" } } } }, - "collector_training":{ - "title":"Collector training", - "description":"Describes the training provided to data collectors including interviewer training, process testing, compliance with standards etc. This is repeatable for language and to capture different aspects of the training process. The type attribute allows specification of the type of training being described.", - "type":"object", - "properties":{ - "type":{ - "title":"Training type", - "description":"The percentage of sample members who provided information", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/collectorTraining/@type" - }, - "training":{ - "title":"Training", - "description":"Training provided to data collectors", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/collectorTraining" + "collector_training": { + "title": "Collector training", + "description": "Describes the training provided to data collectors including interviewer training, process testing, compliance with standards etc. This is repeatable for language and to capture different aspects of the training process. The type attribute allows specification of the type of training being described.", + "type": "array", + "items":{ + "type":"object", + "properties": { + "type": { + "title": "Training type", + "description": "The percentage of sample members who provided information", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/collectorTraining/@type" + }, + "training": { + "title": "Training", + "description": "Training provided to data collectors", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/collectorTraining" + } } } }, - "frequency":{ - "title":"Frequency of Data Collection", - "description":"For data collected at more than one point in time, the frequency with which the data were collected. Examples `monthly`, `quarterly`, `yearly`", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/frequenc" + "frequency": { + "title": "Frequency of Data Collection", + "description": "For data collected at more than one point in time, the frequency with which the data were collected. Examples `monthly`, `quarterly`, `yearly`", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/frequenc" }, - "sampling_procedure":{ - "title":"Sampling Procedure", - "description":"The type of sample and sample design used to select the survey respondents to represent the population. \nThis field only applies to sample surveys. Information on sampling procedure is crucial (although not applicable for censuses and administrative datasets). Examples `National multistage area probability sample`, `Simple random sample`, `Quota sample`", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampProc" + "sampling_procedure": { + "title": "Sampling Procedure", + "description": "The type of sample and sample design used to select the survey respondents to represent the population. \nThis field only applies to sample surveys. Information on sampling procedure is crucial (although not applicable for censuses and administrative datasets). Examples `National multistage area probability sample`, `Simple random sample`, `Quota sample`", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampProc" }, - "sample_frame":{ - "title":"Sample Frame", - "description":"Sample frame describes the sampling frame used for identifying the population from which the sample was taken. For example, a telephone book may be a sample frame for a phone survey. In addition to the name, label and text describing the sample frame, this structure lists who maintains the sample frame, the period for which it is valid, a use statement, the universe covered, the type of unit contained in the frame as well as the number of units available, the reference period of the frame and procedures used to update the frame.", - "type":"object", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame", - "properties":{ - "name":{ - "title":"Sample frame name", - "description":"Sample frame name", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/sampleFrameName" + "sample_frame": { + "title": "Sample Frame", + "description": "Sample frame describes the sampling frame used for identifying the population from which the sample was taken. For example, a telephone book may be a sample frame for a phone survey. In addition to the name, label and text describing the sample frame, this structure lists who maintains the sample frame, the period for which it is valid, a use statement, the universe covered, the type of unit contained in the frame as well as the number of units available, the reference period of the frame and procedures used to update the frame.", + "type": "object", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame", + "properties": { + "name": { + "title": "Sample frame name", + "description": "Sample frame name", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/sampleFrameName" }, - "valid_period":{ - "type":"array", - "title":"Valid periods (YYYY/MM/DD)", - "description":"Defines a time period for the validity of the sampling frame. Enter dates in YYYY-MM-DD format.", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/validPeriod", - "items":{ - "type":"object", - "properties":{ - "event":{ - "title":"Event", - "description":"Event e.g. start, end", - "type":"string" + "valid_period": { + "type": "array", + "title": "Valid periods (YYYY/MM/DD)", + "description": "Defines a time period for the validity of the sampling frame. Enter dates in YYYY-MM-DD format.", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/validPeriod", + "items": { + "type": "object", + "properties": { + "event": { + "title": "Event", + "description": "Event e.g. start, end", + "type": "string" }, - "date":{ - "title":"Date", - "description":"Date", - "type":"string" + "date": { + "title": "Date", + "description": "Date", + "type": "string" } }, - "required":[ + "required": [ "date" ] } }, - "custodian":{ - "title":"Custodian", - "description":"Custodian identifies the agency or individual who is responsible for creating or maintaining the sample frame.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/custodian" + "custodian": { + "title": "Custodian", + "description": "Custodian identifies the agency or individual who is responsible for creating or maintaining the sample frame.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/custodian" }, - "universe":{ - "title":"Universe", - "description":"The group of persons or other elements that are the object of research and to which any analytic results refer.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/universe" + "universe": { + "title": "Universe", + "description": "The group of persons or other elements that are the object of research and to which any analytic results refer.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/universe" }, - "frame_unit":{ - "type":"object", - "title":"Frame unit", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/frameUnit", - "description":"Provides information about the sampling frame unit. The attribute `isPrimary` is boolean, indicating whether the unit is primary or not.", - "properties":{ - "is_primary":{ - "title":"Is Primary", - "description":"Is a primary unit?", - "type":["boolean","string"], - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/frameUnit/@isPrimary" + "frame_unit": { + "type": "object", + "title": "Frame unit", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/frameUnit", + "description": "Provides information about the sampling frame unit. The attribute `isPrimary` is boolean, indicating whether the unit is primary or not.", + "properties": { + "is_primary": { + "title": "Is Primary", + "description": "Is a primary unit?", + "type": [ + "boolean", + "string" + ], + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/frameUnit/@isPrimary" }, - "unit_type":{ - "title":"Unit Type", - "description":"Describes the type of sampling frame unit. The field `num_of_units` provides the number of units in the sampling frame.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/frameUnit/unitType" + "unit_type": { + "title": "Unit Type", + "description": "Describes the type of sampling frame unit. The field `num_of_units` provides the number of units in the sampling frame.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/frameUnit/unitType" }, - "num_of_units":{ - "title":"Number of units", - "description":"Number of units in the sampling frame", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/frameUnit/@numberOfUnits" + "num_of_units": { + "title": "Number of units", + "description": "Number of units in the sampling frame", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/frameUnit/@numberOfUnits" } } }, - "reference_period":{ - "type":"array", - "title":"Reference periods (YYYY/MM/DD)", - "description":"Indicates the period of time in which the sampling frame was actually used for the study in question. Use ISO 8601 date/time formats to enter the relevant date(s).", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/referencePeriod", - "items":{ - "type":"object", - "properties":{ - "event":{ - "title":"Event", - "description":"Event e.g. start, end", - "type":"string" + "reference_period": { + "type": "array", + "title": "Reference periods (YYYY/MM/DD)", + "description": "Indicates the period of time in which the sampling frame was actually used for the study in question. Use ISO 8601 date/time formats to enter the relevant date(s).", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/referencePeriod", + "items": { + "type": "object", + "properties": { + "event": { + "title": "Event", + "description": "Event e.g. start, end", + "type": "string" }, - "date":{ - "title":"Date", - "description":"Date", - "type":"string" + "date": { + "title": "Date", + "description": "Date", + "type": "string" } }, - "required":[ + "required": [ "date" ] } }, - "update_procedure":{ - "title":"Update procedure", - "description":"Description of how and with what frequency the sample frame is updated.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/updateProcedure" + "update_procedure": { + "title": "Update procedure", + "description": "Description of how and with what frequency the sample frame is updated.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/updateProcedure" } } }, - "sampling_deviation":{ - "title":"Deviations from the Sample Design", - "description":"This field only applies to sample surveys.\nSometimes the reality of the field requires a deviation from the sampling design (for example due to difficulty to access to zones due to weather problems, political instability, etc). If for any reason, the sample design has deviated, this should be reported here. ", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/deviat" + "sampling_deviation": { + "title": "Deviations from the Sample Design", + "description": "This field only applies to sample surveys.\nSometimes the reality of the field requires a deviation from the sampling design (for example due to difficulty to access to zones due to weather problems, political instability, etc). If for any reason, the sample design has deviated, this should be reported here. ", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/deviat" }, - "coll_mode":{ - "title":"Mode of data collection", - "type":["string","array"], - "description":"The mode of data collection is the manner in which the interview was conducted or information was gathered. In most cases, the response will be 'face to face interview'. But for some specific kinds of datasets, such as for example data on rain fall, the response will be different.", - "_ddi_xpath":"stdyDscr/method/dataColl/collMode", - "enum_":[ + "coll_mode": { + "title": "Mode of data collection", + "type": [ + "string", + "array" + ], + "description": "The mode of data collection is the manner in which the interview was conducted or information was gathered. In most cases, the response will be 'face to face interview'. But for some specific kinds of datasets, such as for example data on rain fall, the response will be different.", + "_ddi_xpath": "stdyDscr/method/dataColl/collMode", + "enum_": [ "Computer Assisted Personal Interview[capi]", "Computer Assisted Telephone Interview[cati]", "Face-to-Face[f2f]", @@ -1173,463 +1197,452 @@ "type": "string" } }, - "research_instrument":{ - "title":"Type of Research Instrument", - "description":"The type of data collection instrument used. \n`Structured` indicates an instrument in which all respondents are asked the same questions/tests, possibly with precoded answers. If a small portion of such a questionnaire includes open-ended questions, provide appropriate comments. \n`Semi-structured` indicates that the research instrument contains mainly open-ended questions. \n`Unstructured` indicates that in-depth interviews were conducted.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/resInstru" + "research_instrument": { + "title": "Type of Research Instrument", + "description": "The type of data collection instrument used. \n`Structured` indicates an instrument in which all respondents are asked the same questions/tests, possibly with precoded answers. If a small portion of such a questionnaire includes open-ended questions, provide appropriate comments. \n`Semi-structured` indicates that the research instrument contains mainly open-ended questions. \n`Unstructured` indicates that in-depth interviews were conducted.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/resInstru" }, - "instru_development":{ - "title":"Instrument development", - "description":"Describe any development work on the data collection instrument. Type attribute allows for the optional use of a defined development type with or without use of a controlled vocabulary.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/instrumentDevelopment" + "instru_development": { + "title": "Instrument development", + "description": "Describe any development work on the data collection instrument. Type attribute allows for the optional use of a defined development type with or without use of a controlled vocabulary.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/instrumentDevelopment" }, - "instru_development_type":{ - "title":"Instrument development type", - "description":"Instrument development type", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/instrumentDevelopment/@type" + "instru_development_type": { + "title": "Instrument development type", + "description": "Instrument development type", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/instrumentDevelopment/@type" }, - "sources":{ - "type":"object", - "title":"Sources", - "description":"Description of sources used for the data collection. The element is nestable so that the sources statement might encompass a series of discrete source statements, each of which could contain the facts about an individual source. This element maps to Dublin Core Source element.", - "_ddi_xpath":"stdyDscr/method/dataColl/sources", - "properties":{ - "data_source":{ - "title":"Data source", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource/dataSrc", - "type":"array", - "items":{ - "type":"object", - "properties":{ - "source":{ - "title":"Source", - "type":"string" - } - } - } - }, - "source_origin":{ - "type":"string", - "title":"Origin of Source", - "description":"For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcOrig" + "sources": { + "type": "array", + "title": "Sources", + "description": "Description of sources used for the data collection. The element is nestable so that the sources statement might encompass a series of discrete source statements, each of which could contain the facts about an individual source. This element maps to Dublin Core Source element.", + "_ddi_xpath": "stdyDscr/method/dataColl/sources", + "items":{ + "type":"object", + "properties": { + "name": { + "type": "string", + "title": "Source name", + "description": "Name of the source" }, - "source_char":{ - "type":"string", - "title":"Characteristics of Source Noted", - "description":"Assessment of characteristics and quality of source material. May not be relevant to survey data.", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcChar" + "origin": { + "type": "string", + "title": "Origin of Source", + "description": "For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", + "_ddi_xpath": "stdyDscr/method/dataColl/sources/srcOrig" }, - "source_doc":{ - "type":"string", - "title":"Source documentation", - "description":"Documentation and Access to Sources", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcDocu" - } + "characteristics": { + "type": "string", + "title": "Characteristics of Source Noted", + "description": "Assessment of characteristics and quality of source material. May not be relevant to survey data.", + "_ddi_xpath": "stdyDscr/method/dataColl/sources/srcChar" + } } + } }, - "coll_situation":{ - "title":"Characteristics of Data Collection Situation - Notes on data collection", - "__comment":"used for notes on data collection", - "description":"Description of noteworthy aspects of the data collection situation. Includes information on factors such as cooperativeness of respondents, duration of interviews, number of call-backs, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/collSitu" + "coll_situation": { + "title": "Characteristics of Data Collection Situation - Notes on data collection", + "__comment": "used for notes on data collection", + "description": "Description of noteworthy aspects of the data collection situation. Includes information on factors such as cooperativeness of respondents, duration of interviews, number of call-backs, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/collSitu" }, - "act_min":{ - "title":"Supervision", - "description":"Summary of actions taken to minimize data loss. Includes information on actions such as follow-up visits, supervisory checks, historical matching, estimation, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/actMin" + "act_min": { + "title": "Supervision", + "description": "Summary of actions taken to minimize data loss. Includes information on actions such as follow-up visits, supervisory checks, historical matching, estimation, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/actMin" }, - "control_operations":{ - "title":"Control Operations", - "description":" Methods to facilitate data control performed by the primary investigator or by the data archive. Specify any special programs used for such operations.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/ConOps" + "control_operations": { + "title": "Control Operations", + "description": " Methods to facilitate data control performed by the primary investigator or by the data archive. Specify any special programs used for such operations.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/ConOps" }, - "weight":{ - "title":"Weighting", - "description":"The use of sampling procedures may make it necessary to apply weights to produce accurate statistical results. Describe here the criteria for using weights in analysis of a collection. If a weighting formula or coefficient was developed, provide this formula, define its elements, and indicate how the formula is applied to data.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/weight" + "weight": { + "title": "Weighting", + "description": "The use of sampling procedures may make it necessary to apply weights to produce accurate statistical results. Describe here the criteria for using weights in analysis of a collection. If a weighting formula or coefficient was developed, provide this formula, define its elements, and indicate how the formula is applied to data.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/weight" }, - "cleaning_operations":{ - "title":"Cleaning Operations", - "description":"Methods used to `clean` the data collection, e.g., consistency checking, wildcode checking, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/cleanOps" + "cleaning_operations": { + "title": "Cleaning Operations", + "description": "Methods used to `clean` the data collection, e.g., consistency checking, wildcode checking, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/cleanOps" } } }, - "method_notes":{ - "title":"Methodology notes", - "description":"Methodology notes", - "type":"string", - "_ddi_xpath":"stdyDscr/method/notes" + "method_notes": { + "title": "Methodology notes", + "description": "Methodology notes", + "type": "string", + "_ddi_xpath": "stdyDscr/method/notes" }, - "analysis_info":{ - "type":"object", - "title":"Data Appraisal", - "_ddi_xpath":"stdyDscr/method/anlyInfo", - "description":"Information about Data Appraisal", - "properties":{ - "response_rate":{ - "title":"Response Rate", - "description":"The percentage of sample members who provided information", - "type":"string", - "_ddi_xpath":"stdyDscr/method/anlyInfo/respRate" + "analysis_info": { + "type": "object", + "title": "Data Appraisal", + "_ddi_xpath": "stdyDscr/method/anlyInfo", + "description": "Information about Data Appraisal", + "properties": { + "response_rate": { + "title": "Response Rate", + "description": "The percentage of sample members who provided information", + "type": "string", + "_ddi_xpath": "stdyDscr/method/anlyInfo/respRate" }, - "sampling_error_estimates":{ - "title":"Estimates of Sampling Error", - "description":"Measure of how precisely one can estimate a population value from a given sample", - "type":"string", - "_ddi_xpath":"stdyDscr/method/anlyInfo/EstSmpErr" + "sampling_error_estimates": { + "title": "Estimates of Sampling Error", + "description": "Measure of how precisely one can estimate a population value from a given sample", + "type": "string", + "_ddi_xpath": "stdyDscr/method/anlyInfo/EstSmpErr" }, - "data_appraisal":{ - "title":"Data Appraisal", - "description":"Other issues pertaining to data appraisal. Describe here issues such as response variance, nonresponse rate and testing for bias, interviewer and response bias, confidence levels, question bias, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/anlyInfo/dataAppr" + "data_appraisal": { + "title": "Data Appraisal", + "description": "Other issues pertaining to data appraisal. Describe here issues such as response variance, nonresponse rate and testing for bias, interviewer and response bias, confidence levels, question bias, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/anlyInfo/dataAppr" } } }, - "study_class":{ - "title":"Class of the Study", - "description":"Generally used to give the data archive's class or study status number, which indicates the processing status of the study. May also be used as a text field to describe processing status. Example: `DDA Class C`, `Study is available from http://example.com` ", - "type":["string","array"], - "_ddi_xpath":"stdyDscr/method/stdyClas" + "study_class": { + "title": "Class of the Study", + "description": "Generally used to give the data archive's class or study status number, which indicates the processing status of the study. May also be used as a text field to describe processing status. Example: `DDA Class C`, `Study is available from http://example.com` ", + "type": [ + "string", + "array" + ], + "_ddi_xpath": "stdyDscr/method/stdyClas" }, - - "data_processing":{ - "type":"array", - "title":"Data Processing", - "description":"Describes various data processing procedures not captured elsewhere in the documentation, such as topcoding, recoding, suppression, tabulation, etc. The `type` attribute supports better classification of this activity, including the optional use of a controlled vocabulary", - "_ddi_xpath":"stdyDscr/method/dataProcessing", - "items":{ - "type":"object", - "properties":{ - "data_processing":{ - "title":"Data processing", - "type":"string" + "data_processing": { + "type": "array", + "title": "Data Processing", + "description": "Describes various data processing procedures not captured elsewhere in the documentation, such as topcoding, recoding, suppression, tabulation, etc. The `type` attribute supports better classification of this activity, including the optional use of a controlled vocabulary", + "_ddi_xpath": "stdyDscr/method/dataProcessing", + "items": { + "type": "object", + "properties": { + "data_processing": { + "title": "Data processing", + "type": "string" }, - "source":{ - "title":"Source", - "type":"string" + "source": { + "title": "Source", + "type": "string" }, - "type":{ - "title":"Data processing type", - "type":"string" + "type": { + "title": "Data processing type", + "type": "string" } }, - "required":[ + "required": [ "data_processing" ] } }, - - "coding_instructions":{ - "type":"array", - "title":"Coding Instructions", - "_ddi_xpath":"stdyDscr/method/codingInstructions", - "description":"Describe specific coding instructions used in data processing, cleaning, assession, or tabulation.", - "items":{ - "type":"object", - "properties":{ - "related_processes":{ - "title":"Related processes", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/@relatedProcesses" - }, - "type":{ - "title":"Coding instructions type", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/@type" - }, - "txt":{ - "title":"Coding instructions text", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/txt" - }, - "command":{ - "title":"Command", - "description":"Provide command code for the coding instruction. The formalLanguage attribute identifies the language of the command code.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/command" - }, - "command_language":{ - "title":"Language of the command code", - "description":"Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/command/@formalLanguage" - } + "coding_instructions": { + "type": "array", + "title": "Coding Instructions", + "_ddi_xpath": "stdyDscr/method/codingInstructions", + "description": "Describe specific coding instructions used in data processing, cleaning, assession, or tabulation.", + "items": { + "type": "object", + "properties": { + "related_processes": { + "title": "Related processes", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/@relatedProcesses" + }, + "type": { + "title": "Coding instructions type", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/@type" + }, + "txt": { + "title": "Coding instructions text", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/txt" + }, + "command": { + "title": "Command", + "description": "Provide command code for the coding instruction. The formalLanguage attribute identifies the language of the command code.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/command" + }, + "command_language": { + "title": "Language of the command code", + "description": "Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/command/@formalLanguage" } + } } } } }, - "data_access":{ - "type":"object", - "description":"Data Access", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/dataAccs", - "properties":{ - "dataset_availability":{ - "type":"object", - "title":"Data Set Availability", - "description":"Information on availability and storage of the collection", - "properties":{ - "access_place":{ - "title":"Location of Data Collection", - "description":"Location where the data collection is currently stored. Use the URL field `access_place_url` to provide a URN or URL for the storage site or the actual address from which the data may be downloaded", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/accsPlac" + "data_access": { + "type": "object", + "description": "Data Access", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/dataAccs", + "properties": { + "dataset_availability": { + "type": "object", + "title": "Data Set Availability", + "description": "Information on availability and storage of the collection", + "properties": { + "access_place": { + "title": "Location of Data Collection", + "description": "Location where the data collection is currently stored. Use the URL field `access_place_url` to provide a URN or URL for the storage site or the actual address from which the data may be downloaded", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/accsPlac" }, - "access_place_url":{ - "title":"URL for Location of Data Collection", - "description":"Location where the data collection is currently stored. Provide a URN or URL for the storage site or the actual address from which the data may be downloaded", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/accsPlac/@URI" + "access_place_url": { + "title": "URL for Location of Data Collection", + "description": "Location where the data collection is currently stored. Provide a URN or URL for the storage site or the actual address from which the data may be downloaded", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/accsPlac/@URI" }, - "original_archive":{ - "title":"Archive where study is originally stored", - "description":"Archive from which the data collection was obtained; the originating archive", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/origArch" + "original_archive": { + "title": "Archive where study is originally stored", + "description": "Archive from which the data collection was obtained; the originating archive", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/origArch" }, - "status":{ - "title":"Availability Status", - "description":"Statement of collection availability. An archive may need to indicate that a collection is unavailable because it is embargoed for a period of time, because it has been superseded, because a new edition is imminent, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/avlStatus" + "status": { + "title": "Availability Status", + "description": "Statement of collection availability. An archive may need to indicate that a collection is unavailable because it is embargoed for a period of time, because it has been superseded, because a new edition is imminent, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/avlStatus" }, - "coll_size":{ - "title":"Extent of Collection", - "description":"Summarizes the number of physical files that exist in a collection, recording the number of files that contain data and noting whether the collection contains machine-readable documentation and/or other supplementary files and information such as data dictionaries, data definition statements, or data collection instruments.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/collSize" + "coll_size": { + "title": "Extent of Collection", + "description": "Summarizes the number of physical files that exist in a collection, recording the number of files that contain data and noting whether the collection contains machine-readable documentation and/or other supplementary files and information such as data dictionaries, data definition statements, or data collection instruments.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/collSize" }, - "complete":{ - "title":"Completeness of Study Stored", - "description":"This item indicates the relationship of the data collected to the amount of data coded and stored in the data collection. Information as to why certain items of collected information were not included in the data file stored by the archive should be provided", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/complete" + "complete": { + "title": "Completeness of Study Stored", + "description": "This item indicates the relationship of the data collected to the amount of data coded and stored in the data collection. Information as to why certain items of collected information were not included in the data file stored by the archive should be provided", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/complete" }, - "file_quantity":{ - "title":"Number of Files", - "description":"Total number of physical files associated with a collection", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/fileQnty" + "file_quantity": { + "title": "Number of Files", + "description": "Total number of physical files associated with a collection", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/fileQnty" }, - "notes":{ - "title":"Notes", - "description":"Notes and comments", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/notes" + "notes": { + "title": "Notes", + "description": "Notes and comments", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/notes" } } }, - "dataset_use":{ - "type":"object", - "title":"Data Set Availability", - "description":" Information on terms of use for the data collection", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt", - "properties":{ - "conf_dec":{ - "type":"array", - "title":"Confidentiality Declaration", - "description":" This element is used to determine if signing of a confidentiality declaration is needed to access a resource.", - "items":{ + "dataset_use": { + "type": "object", + "title": "Data Set Availability", + "description": " Information on terms of use for the data collection", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt", + "properties": { + "conf_dec": { + "type": "array", + "title": "Confidentiality Declaration", + "description": " This element is used to determine if signing of a confidentiality declaration is needed to access a resource.", + "items": { "type": "object", - "properties":{ - "txt":{ - "type":"string", - "title":"Confidentiality declaration text", - "description":"Confidentiality declaration text", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/confDec" + "properties": { + "txt": { + "type": "string", + "title": "Confidentiality declaration text", + "description": "Confidentiality declaration text", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/confDec" }, - "required":{ - "type":"string", - "title":"Is signing of a confidentiality declaration required?", - "description":"Is signing of a confidentiality declaration required", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/confDec/@required" + "required": { + "type": "string", + "title": "Is signing of a confidentiality declaration required?", + "description": "Is signing of a confidentiality declaration required", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/confDec/@required" }, - "form_url":{ - "type":"string", - "title":"Confidentiality declaration form URL", - "description":"Provide a URN or URL for online access to a confidentiality declaration form.", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/confDec/@URI" + "form_url": { + "type": "string", + "title": "Confidentiality declaration form URL", + "description": "Provide a URN or URL for online access to a confidentiality declaration form.", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/confDec/@URI" }, - "form_id":{ - "type":"string", - "title":"Form ID", - "description":"Indicates the number or ID of the form that the user must fill out", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/confDec/@formNo" + "form_id": { + "type": "string", + "title": "Form ID", + "description": "Indicates the number or ID of the form that the user must fill out", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/confDec/@formNo" } } } }, - "spec_perm":{ - "type":"array", - "title":"Special Permissions", - "description":"Determine if any special permissions are required to access a resource", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/specPerm", - "items":{ + "spec_perm": { + "type": "array", + "title": "Special Permissions", + "description": "Determine if any special permissions are required to access a resource", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/specPerm", + "items": { "type": "object", - "properties":{ - "txt":{ - "type":"string", - "title":"Special permissions description", - "description":"Confidentiality declaration text" + "properties": { + "txt": { + "type": "string", + "title": "Special permissions description", + "description": "Confidentiality declaration text" }, - "required":{ - "type":"string", - "title":"Indicate if special permissions are required to access a resource", - "description":"Indicate if special permissions are required to access a resource" + "required": { + "type": "string", + "title": "Indicate if special permissions are required to access a resource", + "description": "Indicate if special permissions are required to access a resource" }, - "form_url":{ - "type":"string", - "title":"Form URL", - "description":"Link to the form URL" + "form_url": { + "type": "string", + "title": "Form URL", + "description": "Link to the form URL" }, - "form_id":{ - "type":"string", - "title":"Form ID", - "description":"Indicates the number or ID of the form that the user must fill out" + "form_id": { + "type": "string", + "title": "Form ID", + "description": "Indicates the number or ID of the form that the user must fill out" } } } }, - "restrictions":{ - "title":"Restrictions", - "description":"Any restrictions on access to or use of the collection such as privacy certification or distribution restrictions should be indicated here. These can be restrictions applied by the author, producer, or disseminator of the data collection. If the data are restricted to only a certain class of user, specify which type.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/restrctn" + "restrictions": { + "title": "Restrictions", + "description": "Any restrictions on access to or use of the collection such as privacy certification or distribution restrictions should be indicated here. These can be restrictions applied by the author, producer, or disseminator of the data collection. If the data are restricted to only a certain class of user, specify which type.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/restrctn" }, - "contact":{ - "type":"array", - "title":"Contact", - "description":"Contact", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/contact", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "contact": { + "type": "array", + "title": "Contact", + "description": "Contact", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/contact", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" }, - "email":{ - "title":"Email", - "type":"string" + "email": { + "title": "Email", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "cit_req":{ - "title":"Citation requirement", - "description":"Text of requirement that a data collection should be cited properly in articles or other publications that are based on analysis of the data.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/citReq" + "cit_req": { + "title": "Citation requirement", + "description": "Text of requirement that a data collection should be cited properly in articles or other publications that are based on analysis of the data.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/citReq" }, - "deposit_req":{ - "title":"Deposit requirement", - "description":"Information regarding user responsibility for informing archives of their use of data through providing citations to the published work or providing copies of the manuscripts.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/deposReq" + "deposit_req": { + "title": "Deposit requirement", + "description": "Information regarding user responsibility for informing archives of their use of data through providing citations to the published work or providing copies of the manuscripts.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/deposReq" }, - "conditions":{ - "title":"Conditions", - "description":"Indicates any additional information that will assist the user in understanding the access and use conditions of the data collection.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/conditions" + "conditions": { + "title": "Conditions", + "description": "Indicates any additional information that will assist the user in understanding the access and use conditions of the data collection.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/conditions" }, - "disclaimer":{ - "title":"Disclaimer", - "description":"Information regarding responsibility for uses of the data collection", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/disclaimer" + "disclaimer": { + "title": "Disclaimer", + "description": "Information regarding responsibility for uses of the data collection", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/disclaimer" } } }, - "notes":{ - "title":"Notes", - "description":"Notes and comments", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/notes" + "notes": { + "title": "Notes", + "description": "Notes and comments", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/notes" } } } }, - "required":[ + "required": [ "title_statement", "study_info" ], - "additionalProperties":false + "additionalProperties": false } }, - "type":"object", - "properties":{ - "doc_desc":{ - "$ref":"#/definitions/doc_desc" + "type": "object", + "properties": { + "doc_desc": { + "$ref": "#/definitions/doc_desc" }, - "study_desc":{ - "$ref":"#/definitions/study_desc" + "study_desc": { + "$ref": "#/definitions/study_desc" }, - "data_files":{ - "type":"array", - "description":"Data files", - "items":{ - "$ref":"datafile-schema.json" + "data_files": { + "type": "array", + "description": "Data files", + "items": { + "$ref": "datafile-schema.json" } }, - "variables":{ - "type":"array", - "description":"Variables", - "items":{ - "$ref":"variable-schema.json" + "variables": { + "type": "array", + "description": "Variables", + "items": { + "$ref": "variable-schema.json" } }, - "variable_groups":{ - "type":"array", - "description":"Variable group", - "title":"Variable groups", - "items":{ - "type":"object", - "properties":{ - "vgid":{ - "title":"Variable Group ID", - "description":"Unique ID for the variable group e.g. VG1", - "type":"string", + "variable_groups": { + "type": "array", + "description": "Variable group", + "title": "Variable groups", + "items": { + "type": "object", + "properties": { + "vgid": { + "title": "Variable Group ID", + "description": "Unique ID for the variable group e.g. VG1", + "type": "string", "maxLength": 45 }, - "variables":{ - "title":"Variables", - "description":"List of variables for the group seperated by space e.g. V1 V2 V3", - "type":"string", + "variables": { + "title": "Variables", + "description": "List of variables for the group seperated by space e.g. V1 V2 V3", + "type": "string", "maxLength": 5000 }, - "variable_groups":{ - "title":"Variable groups", - "description":"List of sub-groups e.g. VG2 VG3 VG4", - "type":"string", + "variable_groups": { + "title": "Variable groups", + "description": "List of sub-groups e.g. VG2 VG3 VG4", + "type": "string", "maxLength": 1000 }, - "group_type":{ - "title":"Type", - "type":"string", - "enum":[ + "group_type": { + "title": "Type", + "type": "string", + "enum": [ "subject", "section", "multiResp", @@ -1647,37 +1660,37 @@ ], "maxLength": 45 }, - "label":{ - "title":"Label", - "type":"string", + "label": { + "title": "Label", + "type": "string", "maxLength": 255 }, - "universe":{ - "title":"Universe", - "type":"string", + "universe": { + "title": "Universe", + "type": "string", "maxLength": 255 }, - "notes":{ - "title":"Notes", - "type":"string", + "notes": { + "title": "Notes", + "type": "string", "maxLength": 500 }, - "txt":{ - "title":"Text", - "type":"string", + "txt": { + "title": "Text", + "type": "string", "maxLength": 500 }, - "definition":{ - "title":"Definition", - "type":"string", + "definition": { + "title": "Definition", + "type": "string", "maxLength": 500 } }, - "required":[ + "required": [ "vgid" ] }, - "additionalProperties":false + "additionalProperties": false } } } \ No newline at end of file diff --git a/application/schemas/ddi-schema.json b/application/schemas/ddi-schema.json index 57783b4b5..c3dfa6cfb 100644 --- a/application/schemas/ddi-schema.json +++ b/application/schemas/ddi-schema.json @@ -1,782 +1,781 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "http://ihsn.org/schemas/ddi2-codebook", - "version":"0.0", - "title":"Survey Microdata Schema Draft", - "description":"Schema for Survey data type based on DDI 2.5", - "definitions":{ - "doc_desc":{ - "type":"object", - "title":"Document Description", - "description":"Document Description", - "_ddi_xpath":"docDscr", - "properties":{ - "title":{ - "title":"Document title", - "description":"Document title", - "type":"string", - "_ddi_xpath":"docDscr/citation/titlStmt/titl" + "version": "0.0", + "title": "Survey Microdata Schema Draft", + "description": "Schema for Survey data type based on DDI 2.5", + "definitions": { + "doc_desc": { + "type": "object", + "title": "Document Description", + "description": "Document Description", + "_ddi_xpath": "docDscr", + "properties": { + "title": { + "title": "Document title", + "description": "Document title", + "type": "string", + "_ddi_xpath": "docDscr/citation/titlStmt/titl" }, - "idno":{ - "title":"Unique ID number for the document", - "type":"string", - "_ddi_xpath":"docDscr/citation/titlStmt/IDNo" + "idno": { + "title": "Unique ID number for the document", + "type": "string", + "_ddi_xpath": "docDscr/citation/titlStmt/IDNo" }, - "producers":{ - "type":"array", - "title":"Producers", - "description":"List of producers", - "_ddi_xpath":"docDscr/citation/prodStmt/producer", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "description":"Name (required)", - "type":"string" + "producers": { + "type": "array", + "title": "Producers", + "description": "List of producers", + "_ddi_xpath": "docDscr/citation/prodStmt/producer", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Name (required)", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "affiliation":{ - "type":"string", - "title":"Affiliation" + "affiliation": { + "type": "string", + "title": "Affiliation" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "prod_date":{ - "title":"Date of Production", - "description":"Document production date using format(YYYY-MM-DD)", - "type":"string", - "_ddi_xpath":"docDscr/citation/prodStmt/prodDate" + "prod_date": { + "title": "Date of Production", + "description": "Document production date using format(YYYY-MM-DD)", + "type": "string", + "_ddi_xpath": "docDscr/citation/prodStmt/prodDate" }, - "version_statement":{ - "type":"object", - "title":"Version Statement", - "description":"Version Statement", - "_ddi_xpath":"docDscr/citation/verStmt", - "properties":{ - "version":{ - "title":"Version", - "type":"string", - "_ddi_xpath":"docDscr/citation/verStmt/version" + "version_statement": { + "type": "object", + "title": "Version Statement", + "description": "Version Statement", + "_ddi_xpath": "docDscr/citation/verStmt", + "properties": { + "version": { + "title": "Version", + "type": "string", + "_ddi_xpath": "docDscr/citation/verStmt/version" }, - "version_date":{ - "title":"Version Date", - "type":"string", - "_ddi_xpath":"docDscr/citation/verStmt/version/@date" + "version_date": { + "title": "Version Date", + "type": "string", + "_ddi_xpath": "docDscr/citation/verStmt/version/@date" }, - "version_resp":{ - "title":"Version Responsibility Statement", - "description":"The organization or person responsible for the version of the work", - "type":"string", - "_ddi_xpath":"docDscr/citation/verStmt/verResp" + "version_resp": { + "title": "Version Responsibility Statement", + "description": "The organization or person responsible for the version of the work", + "type": "string", + "_ddi_xpath": "docDscr/citation/verStmt/verResp" }, - "version_notes":{ - "title":"Version Notes", - "type":"string", - "_ddi_xpath":"docDscr/citation/verStmt/notes" + "version_notes": { + "title": "Version Notes", + "type": "string", + "_ddi_xpath": "docDscr/citation/verStmt/notes" } } } }, - "additionalProperties":false + "additionalProperties": false }, - "study_desc":{ - "type":"object", - "description":"Study Description", - "_ddi_xpath":"stdyDscr", - "properties":{ - "title_statement":{ - "type":"object", - "description":"Study title", - "_ddi_xpath":"stdyDscr/citation/titlStmt", - "properties":{ - "idno":{ - "type":"string", - "title":"Unique user defined ID", - "description":"The ID number of a dataset is a unique number that is used to identify a particular survey. Define and use a consistent scheme to use. Such an ID could be constructed as follows: country-producer-survey-year-version where \n - country is the 3-letter ISO country abbreviation \n - producer is the abbreviation of the producing agency \n - survey is the survey abbreviation \n - year is the reference year (or the year the survey started) \n - version is the number dataset version number (see Version Description below)", - "_ddi_xpath":"stdyDscr/citation/titlStmt/IDNo" + "study_desc": { + "type": "object", + "description": "Study Description", + "_ddi_xpath": "stdyDscr", + "properties": { + "title_statement": { + "type": "object", + "description": "Study title", + "_ddi_xpath": "stdyDscr/citation/titlStmt", + "properties": { + "idno": { + "type": "string", + "title": "Unique user defined ID", + "description": "The ID number of a dataset is a unique number that is used to identify a particular survey. Define and use a consistent scheme to use. Such an ID could be constructed as follows: country-producer-survey-year-version where \n - country is the 3-letter ISO country abbreviation \n - producer is the abbreviation of the producing agency \n - survey is the survey abbreviation \n - year is the reference year (or the year the survey started) \n - version is the number dataset version number (see Version Description below)", + "_ddi_xpath": "stdyDscr/citation/titlStmt/IDNo" }, - "identifiers":{ - "type":"array", - "title":"Other identifiers", - "description":"Other identifiers", - "items":{ - "type":"object", - "properties":{ - "type":{ - "title":"Identifier type", - "description":"Type of identifier e.g. `doi`, `handle`, `other`", - "type":"string" + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" }, - "identifier":{ - "title":"Identifier", - "type":"string" + "identifier": { + "title": "Identifier", + "type": "string" } }, - "required":[ + "required": [ "identifier" ] } }, - - "title":{ - "type":"string", - "title":"Survey title", - "description":"The title is the official name of the survey as it is stated on the questionnaire or as it appears in the design documents. The following items should be noted:\n - Include the reference year(s) of the survey in the title. \n - Do not include the abbreviation of the survey name in the title. \n - As the survey title is a proper noun, the first letter of each word should be capitalized (except for prepositions or other conjunctions).\n - Including the country name in the title is optional.", - "_ddi_xpath":"stdyDscr/citation/titlStmt/titl" + "title": { + "type": "string", + "title": "Survey title", + "description": "The title is the official name of the survey as it is stated on the questionnaire or as it appears in the design documents. The following items should be noted:\n - Include the reference year(s) of the survey in the title. \n - Do not include the abbreviation of the survey name in the title. \n - As the survey title is a proper noun, the first letter of each word should be capitalized (except for prepositions or other conjunctions).\n - Including the country name in the title is optional.", + "_ddi_xpath": "stdyDscr/citation/titlStmt/titl" }, - "sub_title":{ - "type":"string", - "title":"Survey subtitle", - "description":"A short subtitle for the survey", - "_ddi_xpath":"stdyDscr/citation/titlStmt/subTitl" + "sub_title": { + "type": "string", + "title": "Survey subtitle", + "description": "A short subtitle for the survey", + "_ddi_xpath": "stdyDscr/citation/titlStmt/subTitl" }, - "alternate_title":{ - "type":"string", - "title":"Abbreviation or Acronym", - "description":"The abbreviation of a survey is usually the first letter of each word of the titled survey. The survey reference year(s) may be included.", - "_ddi_xpath":"stdyDscr/citation/titlStmt/altTitl" + "alternate_title": { + "type": "string", + "title": "Abbreviation or Acronym", + "description": "The abbreviation of a survey is usually the first letter of each word of the titled survey. The survey reference year(s) may be included.", + "_ddi_xpath": "stdyDscr/citation/titlStmt/altTitl" }, - "translated_title":{ - "title":"Translated Title", - "description":"In countries with more than one official language, a translation of the title may be provided.", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/titlStmt/parTitl" + "translated_title": { + "title": "Translated Title", + "description": "In countries with more than one official language, a translation of the title may be provided.", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/titlStmt/parTitl" } }, - "required":[ + "required": [ "idno", "title" ] }, - "authoring_entity":{ - "type":"array", - "title":"Authoring entity/Primary investigators", - "description":"The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", - "_ddi_xpath":"stdyDscr/citation/rspStmt/AuthEnty", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Agency Name", - "type":"string" + "authoring_entity": { + "type": "array", + "title": "Authoring entity/Primary investigators", + "description": "The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", + "_ddi_xpath": "stdyDscr/citation/rspStmt/AuthEnty", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Agency Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "oth_id":{ - "type":"array", - "title":"Other Identifications/Acknowledgments", - "description":"Acknowledge any other people and institutions that have in some form contributed to the survey", - "_ddi_xpath":"stdyDscr/citation/rspStmt/othId", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "description":"Person or Agency name", - "type":"string" + "oth_id": { + "type": "array", + "title": "Other Identifications/Acknowledgments", + "description": "Acknowledge any other people and institutions that have in some form contributed to the survey", + "_ddi_xpath": "stdyDscr/citation/rspStmt/othId", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Person or Agency name", + "type": "string" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "production_statement":{ - "type":"object", - "title":"Production Statement", - "description":"Production Statement", - "_ddi_xpath":"stdyDscr/citation/prodStmt", - "properties":{ - "producers":{ - "type":"array", - "title":"Producers", - "description":"List of producers", - "_ddi_xpath":"stdyDscr/citation/prodStmt/producer", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "description":"Name (required)", - "type":"string" + "production_statement": { + "type": "object", + "title": "Production Statement", + "description": "Production Statement", + "_ddi_xpath": "stdyDscr/citation/prodStmt", + "properties": { + "producers": { + "type": "array", + "title": "Producers", + "description": "List of producers", + "_ddi_xpath": "stdyDscr/citation/prodStmt/producer", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Name (required)", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "affiliation":{ - "type":"string", - "title":"Affiliation" + "affiliation": { + "type": "string", + "title": "Affiliation" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "copyright":{ - "title":"Copyright", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/prodStmt/copyright" + "copyright": { + "title": "Copyright", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/prodStmt/copyright" }, - "prod_date":{ - "title":"Production Date", - "description":"Date when the marked-up document/marked-up document source/data collection/other material(s) were produced (not distributed or archived). The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute. Production date for data collection (2.1.3.3) maps to Dublin Core Date element.", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/prodStmt/prodDate" + "prod_date": { + "title": "Production Date", + "description": "Date when the marked-up document/marked-up document source/data collection/other material(s) were produced (not distributed or archived). The ISO standard for dates (YYYY-MM-DD) is recommended for use with the date attribute. Production date for data collection (2.1.3.3) maps to Dublin Core Date element.", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/prodStmt/prodDate" }, - "prod_place":{ - "title":"Production Place", - "description":"Address of the archive or organization that produced the work", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/prodStmt/prodPlac" + "prod_place": { + "title": "Production Place", + "description": "Address of the archive or organization that produced the work", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/prodStmt/prodPlac" }, - "funding_agencies":{ - "type":"array", - "title":"Funding Agency/Sponsor", - "description":"The source(s) of funds for production of the work. If different funding agencies sponsored different stages of the production process, use the 'role' attribute to distinguish them.", - "_ddi_xpath":"stdyDscr/citation/prodStmt/fundAg", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Funding Agency/Sponsor", - "type":"string" + "funding_agencies": { + "type": "array", + "title": "Funding Agency/Sponsor", + "description": "The source(s) of funds for production of the work. If different funding agencies sponsored different stages of the production process, use the 'role' attribute to distinguish them.", + "_ddi_xpath": "stdyDscr/citation/prodStmt/fundAg", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Funding Agency/Sponsor", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "grant":{ - "title":"Grant Number", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/prodStmt/grantNo" + "grant": { + "title": "Grant Number", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/prodStmt/grantNo" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" } }, - "required":[ + "required": [ "name" ] } - } + } } }, - "distribution_statement":{ - "type":"object", - "title":"Distribution Statement", - "description":"Distribution Statement", - "_ddi_xpath":"stdyDscr/citation/distStmt", - "properties":{ - "distributors":{ - "type":"array", - "title":"Distributor", - "description":"The organization designated by the author or producer to generate copies of the particular work including any necessary editions or revisions. Names and addresses may be specified and other archives may be co-distributors. A URI attribute is included to provide an URN or URL to the ordering service or download facility on a Web site.", - "_ddi_xpath":"stdyDscr/citation/distStmt/distrbtr", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Organization name", - "description":"Organization name", - "type":"string" + "distribution_statement": { + "type": "object", + "title": "Distribution Statement", + "description": "Distribution Statement", + "_ddi_xpath": "stdyDscr/citation/distStmt", + "properties": { + "distributors": { + "type": "array", + "title": "Distributor", + "description": "The organization designated by the author or producer to generate copies of the particular work including any necessary editions or revisions. Names and addresses may be specified and other archives may be co-distributors. A URI attribute is included to provide an URN or URL to the ordering service or download facility on a Web site.", + "_ddi_xpath": "stdyDscr/citation/distStmt/distrbtr", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Organization name", + "description": "Organization name", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "contact":{ - "type":"array", - "title":"Contact", - "description":"Contact", - "_ddi_xpath":"stdyDscr/citation/distStmt/contact", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "contact": { + "type": "array", + "title": "Contact", + "description": "Contact", + "_ddi_xpath": "stdyDscr/citation/distStmt/contact", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "email":{ - "title":"Email", - "type":"string" + "email": { + "title": "Email", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "depositor":{ - "type":"array", - "title":"Depositor", - "description":"Depositor", - "_ddi_xpath":"stdyDscr/citation/distStmt/depositr", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "depositor": { + "type": "array", + "title": "Depositor", + "description": "Depositor", + "_ddi_xpath": "stdyDscr/citation/distStmt/depositr", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "deposit_date":{ - "title":"Date of Deposit", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/distStmt/depDate" + "deposit_date": { + "title": "Date of Deposit", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/distStmt/depDate" }, - "distribution_date":{ - "title":"Date of Distribution", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/distStmt/distDate" + "distribution_date": { + "title": "Date of Distribution", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/distStmt/distDate" } } }, - "series_statement":{ - "type":"object", - "title":"Series Statement", - "description":"Series Statement", - "_ddi_xpath":"stdyDscr/citation/serStmt", - "properties":{ - "series_name":{ - "title":"Series Name", - "description":"The name of the series to which the work belongs.", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/serStmt/serName" + "series_statement": { + "type": "object", + "title": "Series Statement", + "description": "Series Statement", + "_ddi_xpath": "stdyDscr/citation/serStmt", + "properties": { + "series_name": { + "title": "Series Name", + "description": "The name of the series to which the work belongs.", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/serStmt/serName" }, - "series_info":{ - "title":"Series Information", - "description":"A survey may be repeated at regular intervals (such as an annual labour force survey), or be part of an international survey program (such as the MICS, CWIQ, DHS, LSMS and others). The Series information is a description of this `collection` of surveys. A brief description of the characteristics of the survey, including when it started, how many rounds were already implemented, and who is in charge would be provided here.", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/serStmt/serInfo" + "series_info": { + "title": "Series Information", + "description": "A survey may be repeated at regular intervals (such as an annual labour force survey), or be part of an international survey program (such as the MICS, CWIQ, DHS, LSMS and others). The Series information is a description of this `collection` of surveys. A brief description of the characteristics of the survey, including when it started, how many rounds were already implemented, and who is in charge would be provided here.", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/serStmt/serInfo" } } }, - "version_statement":{ - "type":"object", - "title":"Version Statement", - "description":"Version Statement", - "_ddi_xpath":"stdyDscr/citation/verStmt", - "properties":{ - "version":{ - "title":"Version", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/verStmt/version" + "version_statement": { + "type": "object", + "title": "Version Statement", + "description": "Version Statement", + "_ddi_xpath": "stdyDscr/citation/verStmt", + "properties": { + "version": { + "title": "Version", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/verStmt/version" }, - "version_date":{ - "title":"Version Date", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/verStmt/version/@date" + "version_date": { + "title": "Version Date", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/verStmt/version/@date" }, - "version_resp":{ - "title":"Version Responsibility Statement", - "description":"The organization or person responsible for the version of the work", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/verStmt/verResp" + "version_resp": { + "title": "Version Responsibility Statement", + "description": "The organization or person responsible for the version of the work", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/verStmt/verResp" }, - "version_notes":{ - "title":"Version Notes", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/verStmt/notes" + "version_notes": { + "title": "Version Notes", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/verStmt/notes" } } }, - "bib_citation":{ - "type":"string", - "title":"Bibliographic Citation", - "description":"Complete bibliographic reference containing all of the standard elements of a citation that can be used to cite the work. The `'bib_citation_format'` field is provided to enable specification of the particular citation style used, e.g., APA, MLA, Chicago, etc.", - "_ddi_xpath":"stdyDscr/citation/biblCit" + "bib_citation": { + "type": "string", + "title": "Bibliographic Citation", + "description": "Complete bibliographic reference containing all of the standard elements of a citation that can be used to cite the work. The `'bib_citation_format'` field is provided to enable specification of the particular citation style used, e.g., APA, MLA, Chicago, etc.", + "_ddi_xpath": "stdyDscr/citation/biblCit" }, - "bib_citation_format":{ - "type":"string", - "title":"Bibliographic Citation Format", - "description":"Specification of the particular citation style used, e.g., `APA`, `MLA`, `Chicago`, etc.", - "_ddi_xpath":"stdyDscr/citation/biblCit/@format" + "bib_citation_format": { + "type": "string", + "title": "Bibliographic Citation Format", + "description": "Specification of the particular citation style used, e.g., `APA`, `MLA`, `Chicago`, etc.", + "_ddi_xpath": "stdyDscr/citation/biblCit/@format" }, - "holdings":{ - "type":"array", - "title":"Holdings Information", - "description":"Information concerning either the physical or electronic holdings of the cited work. Attributes include: location--The physical location where a copy is held; callno--The call number for a work at the location specified; and URI--A URN or URL for accessing the electronic copy of the cited work.", - "_ddi_xpath":"stdyDscr/citation/holdings", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "holdings": { + "type": "array", + "title": "Holdings Information", + "description": "Information concerning either the physical or electronic holdings of the cited work. Attributes include: location--The physical location where a copy is held; callno--The call number for a work at the location specified; and URI--A URN or URL for accessing the electronic copy of the cited work.", + "_ddi_xpath": "stdyDscr/citation/holdings", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "location":{ - "title":"Location", - "type":"string" + "location": { + "title": "Location", + "type": "string" }, - "callno":{ - "title":"Callno", - "type":"string" + "callno": { + "title": "Callno", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "study_notes":{ - "title":"Study notes", - "type":"string", - "_ddi_xpath":"stdyDscr/citation/notes" + "study_notes": { + "title": "Study notes", + "type": "string", + "_ddi_xpath": "stdyDscr/citation/notes" }, - "study_authorization":{ - "type":"object", - "title":"Study Authorization", - "_ddi_xpath":"stdyDscr/studyAuthorization", - "description":"Provides structured information on the agency that authorized the study, the date of authorization, and an authorization statement", - "properties":{ - "date":{ - "title":"Authorization Date", - "type":"string", - "_ddi_xpath":"stdyDscr/studyAuthorization/@date" + "study_authorization": { + "type": "object", + "title": "Study Authorization", + "_ddi_xpath": "stdyDscr/studyAuthorization", + "description": "Provides structured information on the agency that authorized the study, the date of authorization, and an authorization statement", + "properties": { + "date": { + "title": "Authorization Date", + "type": "string", + "_ddi_xpath": "stdyDscr/studyAuthorization/@date" }, - "agency":{ - "type":"array", - "title":"Authorizing Agency", - "description":"The source(s) of funds for production of the work. If different funding agencies sponsored different stages of the production process, use the 'role' attribute to distinguish them.", - "_ddi_xpath":"stdyDscr/studyAuthorization/authorizingAgency", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Funding Agency/Sponsor", - "type":"string" + "agency": { + "type": "array", + "title": "Authorizing Agency", + "description": "The source(s) of funds for production of the work. If different funding agencies sponsored different stages of the production process, use the 'role' attribute to distinguish them.", + "_ddi_xpath": "stdyDscr/studyAuthorization/authorizingAgency", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Funding Agency/Sponsor", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "authorization_statement":{ - "title":"Authorization Statement", - "description":"Authorization Statement", - "_ddi_xpath":"stdyDscr/studyAuthorization/authorizationStatement", - "type":"string" + "authorization_statement": { + "title": "Authorization Statement", + "description": "Authorization Statement", + "_ddi_xpath": "stdyDscr/studyAuthorization/authorizationStatement", + "type": "string" } } }, - "study_info":{ - "type":"object", - "title":"Study Scope", - "description":"This section contains information about the data collection's scope across several dimensions, including substantive content, geography, and time.", - "_ddi_xpath":"stdyDscr/stdyInfo", - "properties":{ - "study_budget":{ - "title":"Study Budget", - "description":"Provide a clear summary of the pDescribe the budget of the project in as much detail as needed. Use XHTML structure elements to identify discrete pieces of information in a way that facilitates direct transfer of information on the study budget between DDI 2 and DDI 3 structures.urposes, objectives and content of the survey", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/studyBudget" + "study_info": { + "type": "object", + "title": "Study Scope", + "description": "This section contains information about the data collection's scope across several dimensions, including substantive content, geography, and time.", + "_ddi_xpath": "stdyDscr/stdyInfo", + "properties": { + "study_budget": { + "title": "Study Budget", + "description": "Provide a clear summary of the pDescribe the budget of the project in as much detail as needed. Use XHTML structure elements to identify discrete pieces of information in a way that facilitates direct transfer of information on the study budget between DDI 2 and DDI 3 structures.urposes, objectives and content of the survey", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/studyBudget" }, - "keywords":{ - "type":"array", - "description":"Keywords", - "_ddi_xpath":"stdyDscr/stdyInfo/subject/keywords", - "items":{ - "type":"object", - "properties":{ - "keyword":{ - "title":"Keyword", - "type":"string" + "keywords": { + "type": "array", + "description": "Keywords", + "_ddi_xpath": "stdyDscr/stdyInfo/subject/keywords", + "items": { + "type": "object", + "properties": { + "keyword": { + "title": "Keyword", + "type": "string" }, - "vocab":{ - "title":"Vocabulary", - "type":"string" + "vocab": { + "title": "Vocabulary", + "type": "string" }, - "uri":{ - "title":"uri", - "type":"string" - } + "uri": { + "title": "uri", + "type": "string" + } } } }, - "topics":{ - "type":"array", - "title":"Topic Classification", - "description":"Topic Classification", - "_ddi_xpath":"stdyDscr/stdyInfo/subject/topcClas", - "items":{ - "type":"object", - "properties":{ - "topic":{ - "title":"Topic", - "type":"string" + "topics": { + "type": "array", + "title": "Topic Classification", + "description": "Topic Classification", + "_ddi_xpath": "stdyDscr/stdyInfo/subject/topcClas", + "items": { + "type": "object", + "properties": { + "topic": { + "title": "Topic", + "type": "string" }, - "vocab":{ - "title":"Vocab", - "type":"string" + "vocab": { + "title": "Vocab", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } }, - "required":[ + "required": [ "topic" ] } }, - "abstract":{ - "title":"Abstract", - "description":"Provide a clear summary of the purposes, objectives and content of the survey", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/abstract" + "abstract": { + "title": "Abstract", + "description": "Provide a clear summary of the purposes, objectives and content of the survey", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/abstract" }, - "time_periods":{ - "type":"array", - "title":"Time periods (YYYY/MM/DD)", - "description":"This field will usually be left empty. Time period differs from the dates of collection as they represent the period for which the data collected are applicable or relevant.", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/timePrd", - "items":{ - "type":"object", - "properties":{ - "start":{ - "title":"Start date", - "description":"Start date", - "type":"string" + "time_periods": { + "type": "array", + "title": "Time periods (YYYY/MM/DD)", + "description": "This field will usually be left empty. Time period differs from the dates of collection as they represent the period for which the data collected are applicable or relevant.", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/timePrd", + "items": { + "type": "object", + "properties": { + "start": { + "title": "Start date", + "description": "Start date", + "type": "string" }, - "end":{ - "title":"End date", - "description":"End date", - "type":"string" + "end": { + "title": "End date", + "description": "End date", + "type": "string" }, - "cycle":{ - "title":"Cycle", - "description":"Cycle", - "type":"string" + "cycle": { + "title": "Cycle", + "description": "Cycle", + "type": "string" } }, - "required":[ + "required": [ "start" ] } }, - "coll_dates":{ - "type":"array", - "title":"Dates of Data Collection (YYYY/MM/DD)", - "description":"Enter the dates (at least month and year) of the start and end of the data collection. In some cases, data collection for a same survey can be conducted in waves. In such case, you should enter the start and end date of each wave separately, and identify each wave in the 'cycle' field.", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/collDate", - "items":{ - "type":"object", - "properties":{ - "start":{ - "title":"Start date", - "description":"Start date", - "type":"string" + "coll_dates": { + "type": "array", + "title": "Dates of Data Collection (YYYY/MM/DD)", + "description": "Enter the dates (at least month and year) of the start and end of the data collection. In some cases, data collection for a same survey can be conducted in waves. In such case, you should enter the start and end date of each wave separately, and identify each wave in the 'cycle' field.", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/collDate", + "items": { + "type": "object", + "properties": { + "start": { + "title": "Start date", + "description": "Start date", + "type": "string" }, - "end":{ - "title":"End date", - "description":"End date", - "type":"string" + "end": { + "title": "End date", + "description": "End date", + "type": "string" }, - "cycle":{ - "title":"Cycle", - "description":"Cycle", - "type":"string" + "cycle": { + "title": "Cycle", + "description": "Cycle", + "type": "string" } }, - "required":[ + "required": [ "start" ] } }, - "nation":{ - "title":"Country", - "description":"Indicates the country or countries covered in the file. Field `abbreviation` may be used to list common abbreviations; use of ISO country codes is recommended. Maps to Dublin Core Coverage element. Inclusion of this element is recommended.", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/nation", - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "description":"Country name", - "type":"string" + "nation": { + "title": "Country", + "description": "Indicates the country or countries covered in the file. Field `abbreviation` may be used to list common abbreviations; use of ISO country codes is recommended. Maps to Dublin Core Coverage element. Inclusion of this element is recommended.", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/nation", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Country name", + "type": "string" }, - "abbreviation":{ - "title":"Country code", - "description":"Country ISO code", - "type":"string" + "abbreviation": { + "title": "Country code", + "description": "Country ISO code", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "bbox":{ - "title":"Geographic bounding box", - "type":"array", - "_ddi_xpath":"stdyDscr/sumDscr/geoBndBox", - "items":{ - "type":"object", - "properties":{ - "west":{ - "title":"West", - "type":"string" + "bbox": { + "title": "Geographic bounding box", + "type": "array", + "_ddi_xpath": "stdyDscr/sumDscr/geoBndBox", + "items": { + "type": "object", + "properties": { + "west": { + "title": "West", + "type": "string" }, - "east":{ - "title":"East", - "type":"string" + "east": { + "title": "East", + "type": "string" }, - "south":{ - "title":"South", - "type":"string" + "south": { + "title": "South", + "type": "string" }, - "north":{ - "title":"North", - "type":"string" + "north": { + "title": "North", + "type": "string" } } } }, - "bound_poly":{ - "title":"Geographic Bounding Polygon", - "description":"This field allows the creation of multiple polygons to describe in a more detailed manner the geographic area covered by the dataset. It should only be used to define the outer boundaries of a covered area. For example, in the United States, such polygons can be created to define boundaries for Hawaii, Alaska, and the continental United States, but not interior boundaries for the contiguous states. This field is used to refine a coordinate-based search, not to actually map an area. \nIf the boundPoly element is used, then geoBndBox MUST be present, and all points enclosed by the boundPoly MUST be contained within the geoBndBox. Elements westBL, eastBL, southBL, and northBL of the geoBndBox should each be represented in at least one point of the boundPoly description.", - "type":"array", - "_ddi_xpath":"stdyDscr/sumDscr/boundPoly", - "items":{ - "type":"object", - "properties":{ - "lat":{ - "title":"Latitude", - "description":"Latitude (y coordinate) of a point. Valid range expressed in decimal degrees is as follows: -90,0 to 90,0 degrees (latitude)", - "type":"string" + "bound_poly": { + "title": "Geographic Bounding Polygon", + "description": "This field allows the creation of multiple polygons to describe in a more detailed manner the geographic area covered by the dataset. It should only be used to define the outer boundaries of a covered area. For example, in the United States, such polygons can be created to define boundaries for Hawaii, Alaska, and the continental United States, but not interior boundaries for the contiguous states. This field is used to refine a coordinate-based search, not to actually map an area. \nIf the boundPoly element is used, then geoBndBox MUST be present, and all points enclosed by the boundPoly MUST be contained within the geoBndBox. Elements westBL, eastBL, southBL, and northBL of the geoBndBox should each be represented in at least one point of the boundPoly description.", + "type": "array", + "_ddi_xpath": "stdyDscr/sumDscr/boundPoly", + "items": { + "type": "object", + "properties": { + "lat": { + "title": "Latitude", + "description": "Latitude (y coordinate) of a point. Valid range expressed in decimal degrees is as follows: -90,0 to 90,0 degrees (latitude)", + "type": "string" }, - "lon":{ - "title":"longitude", - "description":"Longitude (x coordinate) of a point. Valid range expressed in decimal degrees is as follows: -180,0 to 180,0 degrees (longitude)", - "type":"string" + "lon": { + "title": "longitude", + "description": "Longitude (x coordinate) of a point. Valid range expressed in decimal degrees is as follows: -180,0 to 180,0 degrees (longitude)", + "type": "string" } } } }, - "geog_coverage":{ - "description":" Information on the geographic coverage of the data. Includes the total geographic scope of the data, and any additional levels of geographic coding provided in the variables. Maps to Dublin Core Coverage element. Inclusion of this element in the codebook is recommended.", - "title":"Geographic Coverage", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/geogCover" + "geog_coverage": { + "description": " Information on the geographic coverage of the data. Includes the total geographic scope of the data, and any additional levels of geographic coding provided in the variables. Maps to Dublin Core Coverage element. Inclusion of this element in the codebook is recommended.", + "title": "Geographic Coverage", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/geogCover" }, - "geog_coverage_notes":{ - "description":"Geographic coverage notes", - "title":"Geographic Coverage notes", - "type":"string", - "_ddi_xpath":"stdyDscr/sumDscr/geogCover/txt" + "geog_coverage_notes": { + "description": "Geographic coverage notes", + "title": "Geographic Coverage notes", + "type": "string", + "_ddi_xpath": "stdyDscr/sumDscr/geogCover/txt" }, - "geog_unit":{ - "title":"Geographic Unit", - "description":"Lowest level of geographic aggregation covered by the data", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/geogUnit" + "geog_unit": { + "title": "Geographic Unit", + "description": "Lowest level of geographic aggregation covered by the data", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/geogUnit" }, - "analysis_unit":{ - "title":"Unit of Analysis", - "description":"Basic unit(s) of analysis or observation that the study describes: individuals, families/households, groups, facilities, institutions/organizations, administrative units, physical locations, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/anlyUnit" + "analysis_unit": { + "title": "Unit of Analysis", + "description": "Basic unit(s) of analysis or observation that the study describes: individuals, families/households, groups, facilities, institutions/organizations, administrative units, physical locations, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/anlyUnit" }, - "universe":{ - "title":"Universe", - "description":"We are interested here in the survey universe (not the universe of particular sections of the questionnaires or variables), i.e. in the identification of the population of interest in the survey. The universe will rarely be the entire population of the country. Sample household surveys, for example, usually do not cover homeless, nomads, diplomats, community households. Some surveys may cover only the population of a particular age group, or only male (or female), etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/universe" + "universe": { + "title": "Universe", + "description": "We are interested here in the survey universe (not the universe of particular sections of the questionnaires or variables), i.e. in the identification of the population of interest in the survey. The universe will rarely be the entire population of the country. Sample household surveys, for example, usually do not cover homeless, nomads, diplomats, community households. Some surveys may cover only the population of a particular age group, or only male (or female), etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/universe" }, - "data_kind":{ - "title":"Kind of Data", - "description":"Broad classification of the data", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/sumDscr/dataKind", - "enum_":[ + "data_kind": { + "title": "Kind of Data", + "description": "Broad classification of the data", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/sumDscr/dataKind", + "enum_": [ "Sample survey data[ssd]", "Census/enumeration data[cen]", "Administrative records data[adm]", @@ -785,383 +784,408 @@ "Observation data/ratings[obs]" ] }, - "notes":{ - "title":"Study notes", - "description":"Study notes", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/notes" + "notes": { + "title": "Study notes", + "description": "Study notes", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/notes" }, - "quality_statement":{ - "title":"Quality Statement", - "description":"This structure consists of two parts, standardsCompliance and otherQualityStatements. In standardsCompliance list all specific standards complied with during the execution of this study. Note the standard name and producer and how the study complied with the standard. Enter any additional quality statements in otherQualityStatements.", - "type":"object", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement", - "_comments":"TODO: not clear if this should be repeatable.", - "properties":{ - "standard_name":{ - "title":"Standard name", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement/standardsCompliance/standard/standardName" - }, - "standard_producer":{ - "title":"Standard producer", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement/standardsCompliance/standard/producer" + "quality_statement": { + "title": "Quality Statement", + "description": "The quality statement provides elements to describe compliance with quality standards in the form of a statement and an itemized list of standards complied with, and an element to provide other quality statement.", + "type": "object", + "_ddi_xpath": "stdyDscr/stdyInfo/qualityStatement", + "_comments": "TODO: not clear if this should be repeatable.", + "properties": { + "compliance_description": { + "title": "Standard compliance description", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/qualityStatement/standardsCompliance/complianceDescription" }, - "standard_compliance_desc":{ - "title":"Standard compliance description", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement/standardsCompliance/complianceDescription" + "standards": { + "type": "array", + "title": "Standards", + "description": "Standards", + "_ddi_xpath": "stdyDscr/stdyInfo/qualityStatement/standardsCompliance/standard", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "producer": { + "title": "Producer", + "type": "string" + } + } + }, + "required": [ + "name" + ] }, - "other_quality_statement":{ - "title":"Other quality statement", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/qualityStatement/otherQualityStatement" + "other_quality_statement": { + "title": "Other quality statement", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/qualityStatement/otherQualityStatement" } } - }, - "ex_post_evaluation":{ - "title":"Ex-Post Evaluation", - "description":"This structure consists of two parts, standardsCompliance and otherQualityStatements. In standardsCompliance list all specific standards complied with during the execution of this study. Note the standard name and producer and how the study complied with the standard. Enter any additional quality statements in otherQualityStatements.", - "type":"object", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation", - "_comments":"TODO: not clear if this should be repeatable.", - "properties":{ - "completion_date":{ - "title":"Evaluation completion date", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation/@completionDate" + }, + "ex_post_evaluation": { + "title": "Ex-Post Evaluation", + "description": "This structure consists of two parts, standardsCompliance and otherQualityStatements. In standardsCompliance list all specific standards complied with during the execution of this study. Note the standard name and producer and how the study complied with the standard. Enter any additional quality statements in otherQualityStatements.", + "type": "object", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation", + "_comments": "TODO: not clear if this should be repeatable.", + "properties": { + "completion_date": { + "title": "Evaluation completion date", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation/@completionDate" }, - "type":{ - "title":"Evaluation type", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/@type" + "type": { + "title": "Evaluation type", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/@type" }, - "evaluator":{ - "type":"array", - "title":"Evaluators", - "description":"Evaluators", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation/evaluator", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Funding Agency/Sponsor", - "type":"string" + "evaluator": { + "type": "array", + "title": "Evaluators", + "description": "Evaluators", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation/evaluator", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Funding Agency/Sponsor", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" - }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "evaluation_process":{ - "title":"Evaluation process", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation/evaluationProcess" + "evaluation_process": { + "title": "Evaluation process", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation/evaluationProcess" }, - "outcomes":{ - "title":"Outcomes", - "type":"string", - "_ddi_xpath":"stdyDscr/stdyInfo/exPostEvaluation/outcomes" + "outcomes": { + "title": "Outcomes", + "type": "string", + "_ddi_xpath": "stdyDscr/stdyInfo/exPostEvaluation/outcomes" } } } }, - "required":[ + "required": [ "nation" ] }, - "study_development":{ - "title":"Study Development", - "description":"Describe the process of study development as a series of development activities. These activities can be typed using a controlled vocabulary. Describe the activity, listing participants with their role and affiliation, resources used (sources of information), and the outcome of the development activity.", - "type":"object", - "_ddi_xpath":"stdyDscr/studyDevelopment", - "properties":{ - "activity_type":{ - "title":"Development activity type", - "type":"string", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/@type" - }, - "activity_description":{ - "title":"Development activity description", - "type":"string", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/description" - }, - "participants":{ - "type":"array", - "title":"Participants", - "description":"Participants", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/participant", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Participant name", - "type":"string" + "study_development": { + "title": "Study Development", + "description": "Describe the process of study development as a series of development activities. These activities can be typed using a controlled vocabulary. Describe the activity, listing participants with their role and affiliation, resources used (sources of information), and the outcome of the development activity.", + "type": "object", + "_ddi_xpath": "stdyDscr/studyDevelopment", + "properties": { + "development_activity": { + "type": "array", + "title": "Development activity", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity", + "items": { + "type": "object", + "properties": { + "activity_type": { + "title": "Development activity type", + "type": "string", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/@type" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "activity_description": { + "title": "Development activity description", + "type": "string", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/description" }, - "role":{ - "title":"Role", - "type":"string" - } - }, - "required":[ - "name" - ] - } - }, - "resource":{ - "type":"object", - "title":"Development activity resource", - "description":"Development activity resource", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource", - "properties":{ - "data_source":{ - "title":"Data source", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource/dataSrc", - "type":"array", - "items":{ - "type":"object", - "properties":{ - "source":{ - "title":"Source", - "type":"string" - } + "participants": { + "type": "array", + "title": "Participants", + "description": "Participants", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/participant", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Participant name", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + } + }, + "required": [ + "name" + ] } + }, + "resources": { + "type": "array", + "title": "Development activity resources", + "description": "Development activity resources", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/resource", + "items":{ + "type":"object", + "properties":{ + "name": { + "type": "string", + "title": "Resource name", + "description": "Name of the resource" + }, + "origin": { + "type": "string", + "title": "Origin of resource", + "description": "For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/resource/srcOrig" + }, + "characteristics": { + "type": "string", + "title": "Characteristics of resource", + "description": "Assessment of characteristics and quality of source material. May not be relevant to survey data.", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/resource/srcChar" + } + } + } + }, + "outcome": { + "title": "Development Activity Outcome", + "description": "Development Activity Outcome", + "type": "string", + "_ddi_xpath": "stdyDscr/studyDevelopment/developmentActivity/outcome" } - }, - "source_origin":{ - "type":"string", - "title":"Origin of Source", - "description":"For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource/srcOrig" - }, - "source_char":{ - "type":"string", - "title":"Characteristics of Source Noted", - "description":"Assessment of characteristics and quality of source material. May not be relevant to survey data.", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource/srcChar" } } - }, - "outcome":{ - "title":"Development Activity Outcome", - "description":"Development Activity Outcome", - "type":"string", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/outcome" } } }, - "method":{ - "type":"object", - "title":"Methodology and Processing", - "description":"Methodology and processing", - "_ddi_xpath":"stdyDscr/method", - "properties":{ - "data_collection":{ - "type":"object", - "title":"Data Collection", - "_ddi_xpath":"stdyDscr/method/dataColl", - "description":"Information about the methodology employed in a data collection", - "properties":{ - "time_method":{ - "title":"Time Method", - "description":"The time method or time dimension of the data collection. Examples: `panel survey`, `h>cross-section`, `trend study`, `time-series`", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/timeMeth" + "method": { + "type": "object", + "title": "Methodology and Processing", + "description": "Methodology and processing", + "_ddi_xpath": "stdyDscr/method", + "properties": { + "data_collection": { + "type": "object", + "title": "Data Collection", + "_ddi_xpath": "stdyDscr/method/dataColl", + "description": "Information about the methodology employed in a data collection", + "properties": { + "time_method": { + "title": "Time Method", + "description": "The time method or time dimension of the data collection. Examples: `panel survey`, `h>cross-section`, `trend study`, `time-series`", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/timeMeth" }, - "data_collectors":{ - "title":"Data Collectors", - "description":"The persons and/or agencies that took charge of the data collection. This element includes 3 fields: Name, Abbreviation and the Affiliation. In most cases, we will record here the name of the agency, not the name of interviewers. Only in the case of very small-scale surveys, with a very limited number of interviewers, the name of person will be included as well. The field Affiliation is optional and not relevant in all cases.", - "_ddi_xpath":"stdyDscr/method/dataColl/dataCollector", - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "data_collectors": { + "title": "Data Collectors", + "description": "The persons and/or agencies that took charge of the data collection. This element includes 3 fields: Name, Abbreviation and the Affiliation. In most cases, we will record here the name of the agency, not the name of interviewers. Only in the case of very small-scale surveys, with a very limited number of interviewers, the name of person will be included as well. The field Affiliation is optional and not relevant in all cases.", + "_ddi_xpath": "stdyDscr/method/dataColl/dataCollector", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "abbr":{ - "title":"Abbreviation", - "type":"string" - }, - "role":{ - "title":"Role", - "type":"string" + "abbr": { + "title": "Abbreviation", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" } } } }, - "collector_training":{ - "title":"Collector training", - "description":"Describes the training provided to data collectors including interviewer training, process testing, compliance with standards etc. This is repeatable for language and to capture different aspects of the training process. The type attribute allows specification of the type of training being described.", - "type":"object", - "properties":{ - "type":{ - "title":"Training type", - "description":"The percentage of sample members who provided information", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/collectorTraining/@type" - }, - "training":{ - "title":"Training", - "description":"Training provided to data collectors", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/collectorTraining" + "collector_training": { + "title": "Collector training", + "description": "Describes the training provided to data collectors including interviewer training, process testing, compliance with standards etc. This is repeatable for language and to capture different aspects of the training process. The type attribute allows specification of the type of training being described.", + "type": "array", + "items":{ + "type":"object", + "properties": { + "type": { + "title": "Training type", + "description": "The percentage of sample members who provided information", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/collectorTraining/@type" + }, + "training": { + "title": "Training", + "description": "Training provided to data collectors", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/collectorTraining" + } } } }, - "frequency":{ - "title":"Frequency of Data Collection", - "description":"For data collected at more than one point in time, the frequency with which the data were collected. Examples `monthly`, `quarterly`, `yearly`", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/frequenc" + "frequency": { + "title": "Frequency of Data Collection", + "description": "For data collected at more than one point in time, the frequency with which the data were collected. Examples `monthly`, `quarterly`, `yearly`", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/frequenc" }, - "sampling_procedure":{ - "title":"Sampling Procedure", - "description":"The type of sample and sample design used to select the survey respondents to represent the population. \nThis field only applies to sample surveys. Information on sampling procedure is crucial (although not applicable for censuses and administrative datasets). Examples `National multistage area probability sample`, `Simple random sample`, `Quota sample`", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampProc" + "sampling_procedure": { + "title": "Sampling Procedure", + "description": "The type of sample and sample design used to select the survey respondents to represent the population. \nThis field only applies to sample surveys. Information on sampling procedure is crucial (although not applicable for censuses and administrative datasets). Examples `National multistage area probability sample`, `Simple random sample`, `Quota sample`", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampProc" }, - "sample_frame":{ - "title":"Sample Frame", - "description":"Sample frame describes the sampling frame used for identifying the population from which the sample was taken. For example, a telephone book may be a sample frame for a phone survey. In addition to the name, label and text describing the sample frame, this structure lists who maintains the sample frame, the period for which it is valid, a use statement, the universe covered, the type of unit contained in the frame as well as the number of units available, the reference period of the frame and procedures used to update the frame.", - "type":"object", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame", - "properties":{ - "name":{ - "title":"Sample frame name", - "description":"Sample frame name", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/sampleFrameName" + "sample_frame": { + "title": "Sample Frame", + "description": "Sample frame describes the sampling frame used for identifying the population from which the sample was taken. For example, a telephone book may be a sample frame for a phone survey. In addition to the name, label and text describing the sample frame, this structure lists who maintains the sample frame, the period for which it is valid, a use statement, the universe covered, the type of unit contained in the frame as well as the number of units available, the reference period of the frame and procedures used to update the frame.", + "type": "object", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame", + "properties": { + "name": { + "title": "Sample frame name", + "description": "Sample frame name", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/sampleFrameName" }, - "valid_period":{ - "type":"array", - "title":"Valid periods (YYYY/MM/DD)", - "description":"Defines a time period for the validity of the sampling frame. Enter dates in YYYY-MM-DD format.", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/validPeriod", - "items":{ - "type":"object", - "properties":{ - "event":{ - "title":"Event", - "description":"Event e.g. start, end", - "type":"string" + "valid_period": { + "type": "array", + "title": "Valid periods (YYYY/MM/DD)", + "description": "Defines a time period for the validity of the sampling frame. Enter dates in YYYY-MM-DD format.", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/validPeriod", + "items": { + "type": "object", + "properties": { + "event": { + "title": "Event", + "description": "Event e.g. start, end", + "type": "string" }, - "date":{ - "title":"Date", - "description":"Date", - "type":"string" + "date": { + "title": "Date", + "description": "Date", + "type": "string" } }, - "required":[ + "required": [ "date" ] } }, - "custodian":{ - "title":"Custodian", - "description":"Custodian identifies the agency or individual who is responsible for creating or maintaining the sample frame.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/custodian" + "custodian": { + "title": "Custodian", + "description": "Custodian identifies the agency or individual who is responsible for creating or maintaining the sample frame.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/custodian" }, - "universe":{ - "title":"Universe", - "description":"The group of persons or other elements that are the object of research and to which any analytic results refer.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/universe" + "universe": { + "title": "Universe", + "description": "The group of persons or other elements that are the object of research and to which any analytic results refer.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/universe" }, - "frame_unit":{ - "type":"object", - "title":"Frame unit", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/frameUnit", - "description":"Provides information about the sampling frame unit. The attribute `isPrimary` is boolean, indicating whether the unit is primary or not.", - "properties":{ - "is_primary":{ - "title":"Is Primary", - "description":"Is a primary unit?", - "type":["boolean","string"], - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/frameUnit/@isPrimary" + "frame_unit": { + "type": "object", + "title": "Frame unit", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/frameUnit", + "description": "Provides information about the sampling frame unit. The attribute `isPrimary` is boolean, indicating whether the unit is primary or not.", + "properties": { + "is_primary": { + "title": "Is Primary", + "description": "Is a primary unit?", + "type": [ + "boolean", + "string" + ], + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/frameUnit/@isPrimary" }, - "unit_type":{ - "title":"Unit Type", - "description":"Describes the type of sampling frame unit. The field `num_of_units` provides the number of units in the sampling frame.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/frameUnit/unitType" + "unit_type": { + "title": "Unit Type", + "description": "Describes the type of sampling frame unit. The field `num_of_units` provides the number of units in the sampling frame.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/frameUnit/unitType" }, - "num_of_units":{ - "title":"Number of units", - "description":"Number of units in the sampling frame", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/frameUnit/@numberOfUnits" + "num_of_units": { + "title": "Number of units", + "description": "Number of units in the sampling frame", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/frameUnit/@numberOfUnits" } } }, - "reference_period":{ - "type":"array", - "title":"Reference periods (YYYY/MM/DD)", - "description":"Indicates the period of time in which the sampling frame was actually used for the study in question. Use ISO 8601 date/time formats to enter the relevant date(s).", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/referencePeriod", - "items":{ - "type":"object", - "properties":{ - "event":{ - "title":"Event", - "description":"Event e.g. start, end", - "type":"string" + "reference_period": { + "type": "array", + "title": "Reference periods (YYYY/MM/DD)", + "description": "Indicates the period of time in which the sampling frame was actually used for the study in question. Use ISO 8601 date/time formats to enter the relevant date(s).", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/referencePeriod", + "items": { + "type": "object", + "properties": { + "event": { + "title": "Event", + "description": "Event e.g. start, end", + "type": "string" }, - "date":{ - "title":"Date", - "description":"Date", - "type":"string" + "date": { + "title": "Date", + "description": "Date", + "type": "string" } }, - "required":[ + "required": [ "date" ] } }, - "update_procedure":{ - "title":"Update procedure", - "description":"Description of how and with what frequency the sample frame is updated.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/sampleFrame/updateProcedure" + "update_procedure": { + "title": "Update procedure", + "description": "Description of how and with what frequency the sample frame is updated.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/sampleFrame/updateProcedure" } } }, - "sampling_deviation":{ - "title":"Deviations from the Sample Design", - "description":"This field only applies to sample surveys.\nSometimes the reality of the field requires a deviation from the sampling design (for example due to difficulty to access to zones due to weather problems, political instability, etc). If for any reason, the sample design has deviated, this should be reported here. ", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/deviat" + "sampling_deviation": { + "title": "Deviations from the Sample Design", + "description": "This field only applies to sample surveys.\nSometimes the reality of the field requires a deviation from the sampling design (for example due to difficulty to access to zones due to weather problems, political instability, etc). If for any reason, the sample design has deviated, this should be reported here. ", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/deviat" }, - "coll_mode":{ - "title":"Mode of data collection", - "type":["string","array"], - "description":"The mode of data collection is the manner in which the interview was conducted or information was gathered. In most cases, the response will be 'face to face interview'. But for some specific kinds of datasets, such as for example data on rain fall, the response will be different.", - "_ddi_xpath":"stdyDscr/method/dataColl/collMode", - "enum_":[ + "coll_mode": { + "title": "Mode of data collection", + "type": [ + "string", + "array" + ], + "description": "The mode of data collection is the manner in which the interview was conducted or information was gathered. In most cases, the response will be 'face to face interview'. But for some specific kinds of datasets, such as for example data on rain fall, the response will be different.", + "_ddi_xpath": "stdyDscr/method/dataColl/collMode", + "enum_": [ "Computer Assisted Personal Interview[capi]", "Computer Assisted Telephone Interview[cati]", "Face-to-Face[f2f]", @@ -1173,463 +1197,452 @@ "type": "string" } }, - "research_instrument":{ - "title":"Type of Research Instrument", - "description":"The type of data collection instrument used. \n`Structured` indicates an instrument in which all respondents are asked the same questions/tests, possibly with precoded answers. If a small portion of such a questionnaire includes open-ended questions, provide appropriate comments. \n`Semi-structured` indicates that the research instrument contains mainly open-ended questions. \n`Unstructured` indicates that in-depth interviews were conducted.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/resInstru" + "research_instrument": { + "title": "Type of Research Instrument", + "description": "The type of data collection instrument used. \n`Structured` indicates an instrument in which all respondents are asked the same questions/tests, possibly with precoded answers. If a small portion of such a questionnaire includes open-ended questions, provide appropriate comments. \n`Semi-structured` indicates that the research instrument contains mainly open-ended questions. \n`Unstructured` indicates that in-depth interviews were conducted.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/resInstru" }, - "instru_development":{ - "title":"Instrument development", - "description":"Describe any development work on the data collection instrument. Type attribute allows for the optional use of a defined development type with or without use of a controlled vocabulary.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/instrumentDevelopment" + "instru_development": { + "title": "Instrument development", + "description": "Describe any development work on the data collection instrument. Type attribute allows for the optional use of a defined development type with or without use of a controlled vocabulary.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/instrumentDevelopment" }, - "instru_development_type":{ - "title":"Instrument development type", - "description":"Instrument development type", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/instrumentDevelopment/@type" + "instru_development_type": { + "title": "Instrument development type", + "description": "Instrument development type", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/instrumentDevelopment/@type" }, - "sources":{ - "type":"object", - "title":"Sources", - "description":"Description of sources used for the data collection. The element is nestable so that the sources statement might encompass a series of discrete source statements, each of which could contain the facts about an individual source. This element maps to Dublin Core Source element.", - "_ddi_xpath":"stdyDscr/method/dataColl/sources", - "properties":{ - "data_source":{ - "title":"Data source", - "_ddi_xpath":"stdyDscr/studyDevelopment/developmentActivity/resource/dataSrc", - "type":"array", - "items":{ - "type":"object", - "properties":{ - "source":{ - "title":"Source", - "type":"string" - } - } - } - }, - "source_origin":{ - "type":"string", - "title":"Origin of Source", - "description":"For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcOrig" + "sources": { + "type": "array", + "title": "Sources", + "description": "Description of sources used for the data collection. The element is nestable so that the sources statement might encompass a series of discrete source statements, each of which could contain the facts about an individual source. This element maps to Dublin Core Source element.", + "_ddi_xpath": "stdyDscr/method/dataColl/sources", + "items":{ + "type":"object", + "properties": { + "name": { + "type": "string", + "title": "Source name", + "description": "Name of the source" }, - "source_char":{ - "type":"string", - "title":"Characteristics of Source Noted", - "description":"Assessment of characteristics and quality of source material. May not be relevant to survey data.", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcChar" + "origin": { + "type": "string", + "title": "Origin of Source", + "description": "For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", + "_ddi_xpath": "stdyDscr/method/dataColl/sources/srcOrig" }, - "source_doc":{ - "type":"string", - "title":"Source documentation", - "description":"Documentation and Access to Sources", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcDocu" - } + "characteristics": { + "type": "string", + "title": "Characteristics of Source Noted", + "description": "Assessment of characteristics and quality of source material. May not be relevant to survey data.", + "_ddi_xpath": "stdyDscr/method/dataColl/sources/srcChar" + } } + } }, - "coll_situation":{ - "title":"Characteristics of Data Collection Situation - Notes on data collection", - "__comment":"used for notes on data collection", - "description":"Description of noteworthy aspects of the data collection situation. Includes information on factors such as cooperativeness of respondents, duration of interviews, number of call-backs, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/collSitu" + "coll_situation": { + "title": "Characteristics of Data Collection Situation - Notes on data collection", + "__comment": "used for notes on data collection", + "description": "Description of noteworthy aspects of the data collection situation. Includes information on factors such as cooperativeness of respondents, duration of interviews, number of call-backs, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/collSitu" }, - "act_min":{ - "title":"Supervision", - "description":"Summary of actions taken to minimize data loss. Includes information on actions such as follow-up visits, supervisory checks, historical matching, estimation, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/actMin" + "act_min": { + "title": "Supervision", + "description": "Summary of actions taken to minimize data loss. Includes information on actions such as follow-up visits, supervisory checks, historical matching, estimation, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/actMin" }, - "control_operations":{ - "title":"Control Operations", - "description":" Methods to facilitate data control performed by the primary investigator or by the data archive. Specify any special programs used for such operations.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/ConOps" + "control_operations": { + "title": "Control Operations", + "description": " Methods to facilitate data control performed by the primary investigator or by the data archive. Specify any special programs used for such operations.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/ConOps" }, - "weight":{ - "title":"Weighting", - "description":"The use of sampling procedures may make it necessary to apply weights to produce accurate statistical results. Describe here the criteria for using weights in analysis of a collection. If a weighting formula or coefficient was developed, provide this formula, define its elements, and indicate how the formula is applied to data.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/weight" + "weight": { + "title": "Weighting", + "description": "The use of sampling procedures may make it necessary to apply weights to produce accurate statistical results. Describe here the criteria for using weights in analysis of a collection. If a weighting formula or coefficient was developed, provide this formula, define its elements, and indicate how the formula is applied to data.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/weight" }, - "cleaning_operations":{ - "title":"Cleaning Operations", - "description":"Methods used to `clean` the data collection, e.g., consistency checking, wildcode checking, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/dataColl/cleanOps" + "cleaning_operations": { + "title": "Cleaning Operations", + "description": "Methods used to `clean` the data collection, e.g., consistency checking, wildcode checking, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/dataColl/cleanOps" } } }, - "method_notes":{ - "title":"Methodology notes", - "description":"Methodology notes", - "type":"string", - "_ddi_xpath":"stdyDscr/method/notes" + "method_notes": { + "title": "Methodology notes", + "description": "Methodology notes", + "type": "string", + "_ddi_xpath": "stdyDscr/method/notes" }, - "analysis_info":{ - "type":"object", - "title":"Data Appraisal", - "_ddi_xpath":"stdyDscr/method/anlyInfo", - "description":"Information about Data Appraisal", - "properties":{ - "response_rate":{ - "title":"Response Rate", - "description":"The percentage of sample members who provided information", - "type":"string", - "_ddi_xpath":"stdyDscr/method/anlyInfo/respRate" + "analysis_info": { + "type": "object", + "title": "Data Appraisal", + "_ddi_xpath": "stdyDscr/method/anlyInfo", + "description": "Information about Data Appraisal", + "properties": { + "response_rate": { + "title": "Response Rate", + "description": "The percentage of sample members who provided information", + "type": "string", + "_ddi_xpath": "stdyDscr/method/anlyInfo/respRate" }, - "sampling_error_estimates":{ - "title":"Estimates of Sampling Error", - "description":"Measure of how precisely one can estimate a population value from a given sample", - "type":"string", - "_ddi_xpath":"stdyDscr/method/anlyInfo/EstSmpErr" + "sampling_error_estimates": { + "title": "Estimates of Sampling Error", + "description": "Measure of how precisely one can estimate a population value from a given sample", + "type": "string", + "_ddi_xpath": "stdyDscr/method/anlyInfo/EstSmpErr" }, - "data_appraisal":{ - "title":"Data Appraisal", - "description":"Other issues pertaining to data appraisal. Describe here issues such as response variance, nonresponse rate and testing for bias, interviewer and response bias, confidence levels, question bias, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/anlyInfo/dataAppr" + "data_appraisal": { + "title": "Data Appraisal", + "description": "Other issues pertaining to data appraisal. Describe here issues such as response variance, nonresponse rate and testing for bias, interviewer and response bias, confidence levels, question bias, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/anlyInfo/dataAppr" } } }, - "study_class":{ - "title":"Class of the Study", - "description":"Generally used to give the data archive's class or study status number, which indicates the processing status of the study. May also be used as a text field to describe processing status. Example: `DDA Class C`, `Study is available from http://example.com` ", - "type":["string","array"], - "_ddi_xpath":"stdyDscr/method/stdyClas" + "study_class": { + "title": "Class of the Study", + "description": "Generally used to give the data archive's class or study status number, which indicates the processing status of the study. May also be used as a text field to describe processing status. Example: `DDA Class C`, `Study is available from http://example.com` ", + "type": [ + "string", + "array" + ], + "_ddi_xpath": "stdyDscr/method/stdyClas" }, - - "data_processing":{ - "type":"array", - "title":"Data Processing", - "description":"Describes various data processing procedures not captured elsewhere in the documentation, such as topcoding, recoding, suppression, tabulation, etc. The `type` attribute supports better classification of this activity, including the optional use of a controlled vocabulary", - "_ddi_xpath":"stdyDscr/method/dataProcessing", - "items":{ - "type":"object", - "properties":{ - "data_processing":{ - "title":"Data processing", - "type":"string" + "data_processing": { + "type": "array", + "title": "Data Processing", + "description": "Describes various data processing procedures not captured elsewhere in the documentation, such as topcoding, recoding, suppression, tabulation, etc. The `type` attribute supports better classification of this activity, including the optional use of a controlled vocabulary", + "_ddi_xpath": "stdyDscr/method/dataProcessing", + "items": { + "type": "object", + "properties": { + "data_processing": { + "title": "Data processing", + "type": "string" }, - "source":{ - "title":"Source", - "type":"string" + "source": { + "title": "Source", + "type": "string" }, - "type":{ - "title":"Data processing type", - "type":"string" + "type": { + "title": "Data processing type", + "type": "string" } }, - "required":[ + "required": [ "data_processing" ] } }, - - "coding_instructions":{ - "type":"array", - "title":"Coding Instructions", - "_ddi_xpath":"stdyDscr/method/codingInstructions", - "description":"Describe specific coding instructions used in data processing, cleaning, assession, or tabulation.", - "items":{ - "type":"object", - "properties":{ - "related_processes":{ - "title":"Related processes", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/@relatedProcesses" - }, - "type":{ - "title":"Coding instructions type", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/@type" - }, - "txt":{ - "title":"Coding instructions text", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/txt" - }, - "command":{ - "title":"Command", - "description":"Provide command code for the coding instruction. The formalLanguage attribute identifies the language of the command code.", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/command" - }, - "command_language":{ - "title":"Language of the command code", - "description":"Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", - "type":"string", - "_ddi_xpath":"stdyDscr/method/codingInstructions/command/@formalLanguage" - } + "coding_instructions": { + "type": "array", + "title": "Coding Instructions", + "_ddi_xpath": "stdyDscr/method/codingInstructions", + "description": "Describe specific coding instructions used in data processing, cleaning, assession, or tabulation.", + "items": { + "type": "object", + "properties": { + "related_processes": { + "title": "Related processes", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/@relatedProcesses" + }, + "type": { + "title": "Coding instructions type", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/@type" + }, + "txt": { + "title": "Coding instructions text", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/txt" + }, + "command": { + "title": "Command", + "description": "Provide command code for the coding instruction. The formalLanguage attribute identifies the language of the command code.", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/command" + }, + "command_language": { + "title": "Language of the command code", + "description": "Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", + "type": "string", + "_ddi_xpath": "stdyDscr/method/codingInstructions/command/@formalLanguage" } + } } } } }, - "data_access":{ - "type":"object", - "description":"Data Access", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/dataAccs", - "properties":{ - "dataset_availability":{ - "type":"object", - "title":"Data Set Availability", - "description":"Information on availability and storage of the collection", - "properties":{ - "access_place":{ - "title":"Location of Data Collection", - "description":"Location where the data collection is currently stored. Use the URL field `access_place_url` to provide a URN or URL for the storage site or the actual address from which the data may be downloaded", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/accsPlac" + "data_access": { + "type": "object", + "description": "Data Access", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/dataAccs", + "properties": { + "dataset_availability": { + "type": "object", + "title": "Data Set Availability", + "description": "Information on availability and storage of the collection", + "properties": { + "access_place": { + "title": "Location of Data Collection", + "description": "Location where the data collection is currently stored. Use the URL field `access_place_url` to provide a URN or URL for the storage site or the actual address from which the data may be downloaded", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/accsPlac" }, - "access_place_url":{ - "title":"URL for Location of Data Collection", - "description":"Location where the data collection is currently stored. Provide a URN or URL for the storage site or the actual address from which the data may be downloaded", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/accsPlac/@URI" + "access_place_url": { + "title": "URL for Location of Data Collection", + "description": "Location where the data collection is currently stored. Provide a URN or URL for the storage site or the actual address from which the data may be downloaded", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/accsPlac/@URI" }, - "original_archive":{ - "title":"Archive where study is originally stored", - "description":"Archive from which the data collection was obtained; the originating archive", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/origArch" + "original_archive": { + "title": "Archive where study is originally stored", + "description": "Archive from which the data collection was obtained; the originating archive", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/origArch" }, - "status":{ - "title":"Availability Status", - "description":"Statement of collection availability. An archive may need to indicate that a collection is unavailable because it is embargoed for a period of time, because it has been superseded, because a new edition is imminent, etc.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/avlStatus" + "status": { + "title": "Availability Status", + "description": "Statement of collection availability. An archive may need to indicate that a collection is unavailable because it is embargoed for a period of time, because it has been superseded, because a new edition is imminent, etc.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/avlStatus" }, - "coll_size":{ - "title":"Extent of Collection", - "description":"Summarizes the number of physical files that exist in a collection, recording the number of files that contain data and noting whether the collection contains machine-readable documentation and/or other supplementary files and information such as data dictionaries, data definition statements, or data collection instruments.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/collSize" + "coll_size": { + "title": "Extent of Collection", + "description": "Summarizes the number of physical files that exist in a collection, recording the number of files that contain data and noting whether the collection contains machine-readable documentation and/or other supplementary files and information such as data dictionaries, data definition statements, or data collection instruments.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/collSize" }, - "complete":{ - "title":"Completeness of Study Stored", - "description":"This item indicates the relationship of the data collected to the amount of data coded and stored in the data collection. Information as to why certain items of collected information were not included in the data file stored by the archive should be provided", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/complete" + "complete": { + "title": "Completeness of Study Stored", + "description": "This item indicates the relationship of the data collected to the amount of data coded and stored in the data collection. Information as to why certain items of collected information were not included in the data file stored by the archive should be provided", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/complete" }, - "file_quantity":{ - "title":"Number of Files", - "description":"Total number of physical files associated with a collection", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/fileQnty" + "file_quantity": { + "title": "Number of Files", + "description": "Total number of physical files associated with a collection", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/fileQnty" }, - "notes":{ - "title":"Notes", - "description":"Notes and comments", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/notes" + "notes": { + "title": "Notes", + "description": "Notes and comments", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/notes" } } }, - "dataset_use":{ - "type":"object", - "title":"Data Set Availability", - "description":" Information on terms of use for the data collection", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt", - "properties":{ - "conf_dec":{ - "type":"array", - "title":"Confidentiality Declaration", - "description":" This element is used to determine if signing of a confidentiality declaration is needed to access a resource.", - "items":{ + "dataset_use": { + "type": "object", + "title": "Data Set Availability", + "description": " Information on terms of use for the data collection", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt", + "properties": { + "conf_dec": { + "type": "array", + "title": "Confidentiality Declaration", + "description": " This element is used to determine if signing of a confidentiality declaration is needed to access a resource.", + "items": { "type": "object", - "properties":{ - "txt":{ - "type":"string", - "title":"Confidentiality declaration text", - "description":"Confidentiality declaration text", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/confDec" + "properties": { + "txt": { + "type": "string", + "title": "Confidentiality declaration text", + "description": "Confidentiality declaration text", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/confDec" }, - "required":{ - "type":"string", - "title":"Is signing of a confidentiality declaration required?", - "description":"Is signing of a confidentiality declaration required", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/confDec/@required" + "required": { + "type": "string", + "title": "Is signing of a confidentiality declaration required?", + "description": "Is signing of a confidentiality declaration required", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/confDec/@required" }, - "form_url":{ - "type":"string", - "title":"Confidentiality declaration form URL", - "description":"Provide a URN or URL for online access to a confidentiality declaration form.", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/confDec/@URI" + "form_url": { + "type": "string", + "title": "Confidentiality declaration form URL", + "description": "Provide a URN or URL for online access to a confidentiality declaration form.", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/confDec/@URI" }, - "form_id":{ - "type":"string", - "title":"Form ID", - "description":"Indicates the number or ID of the form that the user must fill out", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/confDec/@formNo" + "form_id": { + "type": "string", + "title": "Form ID", + "description": "Indicates the number or ID of the form that the user must fill out", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/confDec/@formNo" } } } }, - "spec_perm":{ - "type":"array", - "title":"Special Permissions", - "description":"Determine if any special permissions are required to access a resource", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/specPerm", - "items":{ + "spec_perm": { + "type": "array", + "title": "Special Permissions", + "description": "Determine if any special permissions are required to access a resource", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/specPerm", + "items": { "type": "object", - "properties":{ - "txt":{ - "type":"string", - "title":"Special permissions description", - "description":"Confidentiality declaration text" + "properties": { + "txt": { + "type": "string", + "title": "Special permissions description", + "description": "Confidentiality declaration text" }, - "required":{ - "type":"string", - "title":"Indicate if special permissions are required to access a resource", - "description":"Indicate if special permissions are required to access a resource" + "required": { + "type": "string", + "title": "Indicate if special permissions are required to access a resource", + "description": "Indicate if special permissions are required to access a resource" }, - "form_url":{ - "type":"string", - "title":"Form URL", - "description":"Link to the form URL" + "form_url": { + "type": "string", + "title": "Form URL", + "description": "Link to the form URL" }, - "form_id":{ - "type":"string", - "title":"Form ID", - "description":"Indicates the number or ID of the form that the user must fill out" + "form_id": { + "type": "string", + "title": "Form ID", + "description": "Indicates the number or ID of the form that the user must fill out" } } } }, - "restrictions":{ - "title":"Restrictions", - "description":"Any restrictions on access to or use of the collection such as privacy certification or distribution restrictions should be indicated here. These can be restrictions applied by the author, producer, or disseminator of the data collection. If the data are restricted to only a certain class of user, specify which type.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/restrctn" + "restrictions": { + "title": "Restrictions", + "description": "Any restrictions on access to or use of the collection such as privacy certification or distribution restrictions should be indicated here. These can be restrictions applied by the author, producer, or disseminator of the data collection. If the data are restricted to only a certain class of user, specify which type.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/restrctn" }, - "contact":{ - "type":"array", - "title":"Contact", - "description":"Contact", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/contact", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "contact": { + "type": "array", + "title": "Contact", + "description": "Contact", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/contact", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" }, - "email":{ - "title":"Email", - "type":"string" + "email": { + "title": "Email", + "type": "string" } } }, - "required":[ + "required": [ "name" ] }, - "cit_req":{ - "title":"Citation requirement", - "description":"Text of requirement that a data collection should be cited properly in articles or other publications that are based on analysis of the data.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/citReq" + "cit_req": { + "title": "Citation requirement", + "description": "Text of requirement that a data collection should be cited properly in articles or other publications that are based on analysis of the data.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/citReq" }, - "deposit_req":{ - "title":"Deposit requirement", - "description":"Information regarding user responsibility for informing archives of their use of data through providing citations to the published work or providing copies of the manuscripts.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/deposReq" + "deposit_req": { + "title": "Deposit requirement", + "description": "Information regarding user responsibility for informing archives of their use of data through providing citations to the published work or providing copies of the manuscripts.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/deposReq" }, - "conditions":{ - "title":"Conditions", - "description":"Indicates any additional information that will assist the user in understanding the access and use conditions of the data collection.", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/conditions" + "conditions": { + "title": "Conditions", + "description": "Indicates any additional information that will assist the user in understanding the access and use conditions of the data collection.", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/conditions" }, - "disclaimer":{ - "title":"Disclaimer", - "description":"Information regarding responsibility for uses of the data collection", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/useStmt/disclaimer" + "disclaimer": { + "title": "Disclaimer", + "description": "Information regarding responsibility for uses of the data collection", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/useStmt/disclaimer" } } }, - "notes":{ - "title":"Notes", - "description":"Notes and comments", - "type":"string", - "_ddi_xpath":"stdyDscr/dataAccs/setAvail/notes" + "notes": { + "title": "Notes", + "description": "Notes and comments", + "type": "string", + "_ddi_xpath": "stdyDscr/dataAccs/setAvail/notes" } } } }, - "required":[ + "required": [ "title_statement", "study_info" ], - "additionalProperties":false + "additionalProperties": false } }, - "type":"object", - "properties":{ - "doc_desc":{ - "$ref":"#/definitions/doc_desc" + "type": "object", + "properties": { + "doc_desc": { + "$ref": "#/definitions/doc_desc" }, - "study_desc":{ - "$ref":"#/definitions/study_desc" + "study_desc": { + "$ref": "#/definitions/study_desc" }, - "data_files":{ - "type":"array", - "description":"Data files", - "items":{ - "$ref":"datafile-schema.json" + "data_files": { + "type": "array", + "description": "Data files", + "items": { + "$ref": "datafile-schema.json" } }, - "variables":{ - "type":"array", - "description":"Variables", - "items":{ - "$ref":"variable-schema.json" + "variables": { + "type": "array", + "description": "Variables", + "items": { + "$ref": "variable-schema.json" } }, - "variable_groups":{ - "type":"array", - "description":"Variable group", - "title":"Variable groups", - "items":{ - "type":"object", - "properties":{ - "vgid":{ - "title":"Variable Group ID", - "description":"Unique ID for the variable group e.g. VG1", - "type":"string", + "variable_groups": { + "type": "array", + "description": "Variable group", + "title": "Variable groups", + "items": { + "type": "object", + "properties": { + "vgid": { + "title": "Variable Group ID", + "description": "Unique ID for the variable group e.g. VG1", + "type": "string", "maxLength": 45 }, - "variables":{ - "title":"Variables", - "description":"List of variables for the group seperated by space e.g. V1 V2 V3", - "type":"string", + "variables": { + "title": "Variables", + "description": "List of variables for the group seperated by space e.g. V1 V2 V3", + "type": "string", "maxLength": 5000 }, - "variable_groups":{ - "title":"Variable groups", - "description":"List of sub-groups e.g. VG2 VG3 VG4", - "type":"string", + "variable_groups": { + "title": "Variable groups", + "description": "List of sub-groups e.g. VG2 VG3 VG4", + "type": "string", "maxLength": 1000 }, - "group_type":{ - "title":"Type", - "type":"string", - "enum":[ + "group_type": { + "title": "Type", + "type": "string", + "enum": [ "subject", "section", "multiResp", @@ -1647,37 +1660,37 @@ ], "maxLength": 45 }, - "label":{ - "title":"Label", - "type":"string", + "label": { + "title": "Label", + "type": "string", "maxLength": 255 }, - "universe":{ - "title":"Universe", - "type":"string", + "universe": { + "title": "Universe", + "type": "string", "maxLength": 255 }, - "notes":{ - "title":"Notes", - "type":"string", + "notes": { + "title": "Notes", + "type": "string", "maxLength": 500 }, - "txt":{ - "title":"Text", - "type":"string", + "txt": { + "title": "Text", + "type": "string", "maxLength": 500 }, - "definition":{ - "title":"Definition", - "type":"string", + "definition": { + "title": "Definition", + "type": "string", "maxLength": 500 } }, - "required":[ + "required": [ "vgid" ] }, - "additionalProperties":false + "additionalProperties": false } } } \ No newline at end of file From dab1ccb81bbef7a6ce2527469950b6170b3d17d1 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Tue, 15 Feb 2022 13:40:08 +0500 Subject: [PATCH 10/79] misc schema updates --- .../catalog-admin/datafile-schema.json | 5 + .../catalog-admin/ddi-schema.json | 18 ++- .../catalog-admin/geospatial-schema.json | 3 +- api-documentation/catalog-admin/swagger.yaml | 2 +- .../catalog-admin/table-schema.json | 73 +++++++++++- .../catalog-admin/timeseries-db-schema.json | 5 + .../catalog-admin/timeseries-schema.json | 11 +- .../catalog-admin/variable-schema.json | 56 +++++++++- .../schemas/iptc-phovidmdshared-schema.json | 105 +++++++++--------- .../schemas/iptc-pmd-schema.json | 55 +++++++++ application/models/Variable_model.php | 38 +++++-- application/schemas/datafile-schema.json | 5 + application/schemas/ddi-schema.json | 18 ++- application/schemas/geospatial-schema.json | 3 +- .../schemas/iptc-phovidmdshared-schema.json | 105 +++++++++--------- application/schemas/iptc-pmd-schema.json | 55 +++++++++ application/schemas/table-schema.json | 73 +++++++++++- application/schemas/timeseries-db-schema.json | 5 + application/schemas/timeseries-schema.json | 11 +- application/schemas/variable-schema.json | 52 ++++++++- 20 files changed, 540 insertions(+), 158 deletions(-) diff --git a/api-documentation/catalog-admin/datafile-schema.json b/api-documentation/catalog-admin/datafile-schema.json index 6e1b7e1e4..a74e542ac 100644 --- a/api-documentation/catalog-admin/datafile-schema.json +++ b/api-documentation/catalog-admin/datafile-schema.json @@ -12,6 +12,11 @@ "type": "string", "title" : "File name" }, + "file_type": { + "type": "string", + "title" : "File type", + "description": "Types of data files include raw data (ASCII, EBCDIC, etc.) and software-dependent files such as SAS datasets, SPSS export files, etc." + }, "description": { "type": "string", "title": "File description" diff --git a/api-documentation/catalog-admin/ddi-schema.json b/api-documentation/catalog-admin/ddi-schema.json index c3dfa6cfb..4fc2d3e02 100644 --- a/api-documentation/catalog-admin/ddi-schema.json +++ b/api-documentation/catalog-admin/ddi-schema.json @@ -1325,21 +1325,17 @@ "items": { "type": "object", "properties": { - "data_processing": { - "title": "Data processing", - "type": "string" - }, - "source": { - "title": "Source", - "type": "string" - }, "type": { "title": "Data processing type", "type": "string" + }, + "description": { + "title": "Data processing description", + "type": "string" } }, "required": [ - "data_processing" + "description" ] } }, @@ -1372,8 +1368,8 @@ "type": "string", "_ddi_xpath": "stdyDscr/method/codingInstructions/command" }, - "command_language": { - "title": "Language of the command code", + "formal_language": { + "title": "Identify the language of the command code", "description": "Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", "type": "string", "_ddi_xpath": "stdyDscr/method/codingInstructions/command/@formalLanguage" diff --git a/api-documentation/catalog-admin/geospatial-schema.json b/api-documentation/catalog-admin/geospatial-schema.json index 0a045dbe6..67d68df1a 100644 --- a/api-documentation/catalog-admin/geospatial-schema.json +++ b/api-documentation/catalog-admin/geospatial-schema.json @@ -2030,7 +2030,8 @@ }, "additional": { "title": "Additional metadata", - "description": "Any additional metadata" + "description": "Any additional metadata", + "type":"object" } }, "required": [ diff --git a/api-documentation/catalog-admin/swagger.yaml b/api-documentation/catalog-admin/swagger.yaml index ec2ee1398..7c769cb2d 100644 --- a/api-documentation/catalog-admin/swagger.yaml +++ b/api-documentation/catalog-admin/swagger.yaml @@ -37,8 +37,8 @@ x-tagGroups: - Collections - Datasets - External resources - - Survey - Scripts + - Survey - Timeseries - Geospatial - Images diff --git a/api-documentation/catalog-admin/table-schema.json b/api-documentation/catalog-admin/table-schema.json index 983a7517a..f7d52e318 100644 --- a/api-documentation/catalog-admin/table-schema.json +++ b/api-documentation/catalog-admin/table-schema.json @@ -454,9 +454,30 @@ "items": { "type": "object", "properties": { - "source": { - "title": "Source", + "name": { + "title": "Name", + "type": "string", + "description": "The name (title) of the data source. For example, a table data may be extracted from the `Population Census 2020`." + }, + "abbreviation": { + "title": "Abbreviation", + "description":"The abbreviation (acronym) of the data source.", + "type": "string" + }, + "source_id": { + "title": "Source ID", + "description":"A unique identifier for the source, such as a Digital Object Identifier (DOI).", "type": "string" + }, + "note": { + "title": "Note", + "type": "string", + "description":"A note that describes how the source was used, possibly mentioning issues in the use of the source." + }, + "uri": { + "title": "URI", + "type": "string", + "description":"A link (URL) to the source dataset." } } } @@ -621,9 +642,36 @@ "themes":{ "type":"array", "description":"Themes", - "allOf": [ - {"$ref":"#/definitions/keyword"} - ] + "items": { + "type": "object", + "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, + "name": { + "title": "Name", + "type": "string" + }, + "parent_id": { + "title": "Parent Identifier", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Name of the controlled vocabulary", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the theme is from a taxonomy.", + "type": "string" + } + }, + "required": [ + "name" + ] + } }, "topics": { "type": "array", @@ -669,10 +717,19 @@ "items": { "type": "object", "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, "name": { "title": "Discipline title or name", "type": "string" }, + "parent_id": { + "title": "Parent discipline Identifier", + "description":"Parent discipline ID", + "type": "string" + }, "vocabulary": { "title": "Vocabulary", "description": "Vocabulary", @@ -786,6 +843,12 @@ "title":"Confidentiality" }, + "sdc": { + "type": "string", + "title":"Statistical disclosure control", + "description":"Information on statistical disclosure control measures applied to the table. This can include cell suppression, or other techniques. Specialized packages have been developed for this purpose, like [*sdcTable: Methods for Statistical Disclosure Control in Tabular Data*](https://cran.r-project.org/web/packages/sdcTable/index.html) and https://cran.r-project.org/web/packages/sdcTable/sdcTable.pdf \nThe information provided here should be such that it does not provide intruders with useful information for reverse-engineering the protection measures applied to the table." + }, + "contacts": { "type": "array", "title": "Contacts", diff --git a/api-documentation/catalog-admin/timeseries-db-schema.json b/api-documentation/catalog-admin/timeseries-db-schema.json index e7ac76a92..c9c9116f1 100644 --- a/api-documentation/catalog-admin/timeseries-db-schema.json +++ b/api-documentation/catalog-admin/timeseries-db-schema.json @@ -498,6 +498,11 @@ ] }, + "acknowledgement_statement": { + "title": "An overall statement of acknowledgment, which can be used as an alternative (or supplement) to the itemized list provided in `acknowledgments`.", + "type": "string" + }, + "contacts": { "type": "array", "title": "Contacts", diff --git a/api-documentation/catalog-admin/timeseries-schema.json b/api-documentation/catalog-admin/timeseries-schema.json index f620472c3..baac06983 100644 --- a/api-documentation/catalog-admin/timeseries-schema.json +++ b/api-documentation/catalog-admin/timeseries-schema.json @@ -794,10 +794,10 @@ "additionalProperties": false } }, - "word_vectors":{ + "embeddings":{ "type": "array", - "title": "Word vectors", - "description": "Word vectors", + "title": "Word embeddings", + "description": "Word embeddings", "items": { "type": "object", "properties": { @@ -834,6 +834,11 @@ "type": "string", "title": "Name" }, + "description": { + "type": "string", + "title": "Description", + "description":"A brief description of the series group." + }, "version": { "type": "string", "title": "Version" diff --git a/api-documentation/catalog-admin/variable-schema.json b/api-documentation/catalog-admin/variable-schema.json index 7c16ff79e..9d887e678 100644 --- a/api-documentation/catalog-admin/variable-schema.json +++ b/api-documentation/catalog-admin/variable-schema.json @@ -57,8 +57,16 @@ }, "var_imputation": { "type": "string", - "title": "Imputation" + "title": "Imputation", + "description": "According to the Statistical Terminology glossary maintained by the National Science Foundation, this is `the process by which one estimates missing values for items that a survey respondent failed to provide,` and if applicable in this context, it refers to the type of procedure used. " }, + + "var_derivation": { + "type": "string", + "title": "Derivation", + "description": "Used only in the case of a derived variable, this element provides both a description of how the derivation was performed and the command used to generate the derived variable, as well as a specification of the other variables in the study used to generate the derivation. The `var` attribute provides the ID values of the other variables in the study used to generate this derived variable." + }, + "var_security": { "type": "string", "title": "Security" @@ -80,6 +88,19 @@ "type": "string", "title": "Post-question text" }, + + "var_forward": { + "type": "string", + "title": "Forward skip", + "description":"Contains a reference to IDs of possible following questions. This can be used to document forward skip instructions." + }, + + "var_backward": { + "type": "string", + "title": "Backward skip", + "description":"Contains a reference to IDs of possible preceding questions. This can be used to document backward skip instructions." + }, + "var_qstn_ivulnstr": { "type": "string", "title": "Interviewer instructions" @@ -155,6 +176,31 @@ } } }, + + "var_std_catgry": { + "type": "object", + "title": "Standard categories", + "description":"Standard category codes used in the variable, like industry codes, employment codes, or social class codes. The attribute `date` is provided to indicate the version of the code in place at the time of the study. The attribute `URI` is provided to indicate a URN or URL that can be used to obtain an electronic list of the category codes.", + "properties":{ + "name": { + "title": "Standard classification name", + "type": "string" + }, + "source": { + "title": "Source", + "type": "string" + }, + "date": { + "title": "Date", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "var_codinstr": { "type": "string", "title": "Recoding and derivation" @@ -196,9 +242,9 @@ "type": "string", "title": "Name" }, - "value": { + "note": { "type": "string", - "title": "Value" + "title": "Note" } } }, @@ -207,5 +253,5 @@ "title": "Variable notes" } }, - "required": [ "vid", "file_id", "name","labl" ] -} + "required": [ "vid", "file_id", "name","labl" ] +} \ No newline at end of file diff --git a/api-documentation/schemas/iptc-phovidmdshared-schema.json b/api-documentation/schemas/iptc-phovidmdshared-schema.json index 065fd2733..52014c8a1 100644 --- a/api-documentation/schemas/iptc-phovidmdshared-schema.json +++ b/api-documentation/schemas/iptc-phovidmdshared-schema.json @@ -49,25 +49,28 @@ "ArtworkOrObject": { "type": "object", "properties": { - "circaDateCreated": { - "title": "Circa Date Created {Artwork or Object detail}", - "description": "Approximate date or range of dates associated with the creation and production of an artwork or object or its components.", - "type": "string" + "title": { + "$ref": "#/definitions/AltLang", + "description": "A reference for the artwork or object in the image.", + "title": "Title {Artwork or Object detail}" }, "contentDescription": { "$ref": "#/definitions/AltLang", "description": "A textual description of the content depicted in the artwork or object.", "title": "Content Description {Artwork or Object detail}" }, - "contributionDescription": { + "physicalDescription": { "$ref": "#/definitions/AltLang", - "description": "A textual description about a contribution made to an artwork or an object.", - "title": "Contribution Description {Artwork or Object detail}" + "description": "A textual description of the physical characteristics of the artwork or object, without reference to the content depicted.", + "title": "Physical Description {Artwork or Object detail}" }, - "copyrightNotice": { - "$ref": "#/definitions/AltLang", - "description": "Contains any necessary copyright notice for claiming the intellectual property for artwork or an object in the image and should identify the current owner of the copyright of this work with associated intellectual property rights.", - "title": "Copyright Notice {Artwork or Object detail}" + "creatorNames": { + "title": "Creator {Artwork or Object detail}", + "description": "Contains the name of the artist who has created artwork or an object in the image. In cases where the artist could or should not be identified the name of a company or organisation may be appropriate.", + "type": "array", + "items": { + "type": "string" + } }, "creatorIdentifiers": { "title": "Creator ID {Artwork or Object detail}", @@ -77,46 +80,29 @@ "type": "string" } }, - "creatorNames": { - "title": "Creator {Artwork or Object detail}", - "description": "Contains the name of the artist who has created artwork or an object in the image. In cases where the artist could or should not be identified the name of a company or organisation may be appropriate.", + "contributionDescription": { + "$ref": "#/definitions/AltLang", + "description": "A textual description about a contribution made to an artwork or an object.", + "title": "Contribution Description {Artwork or Object detail}" + }, + "stylePeriod": { + "title": "Style Period {Artwork or Object detail}", + "description": "The style, historical or artistic period, movement, group, or school whose characteristics are represented in the artwork or object.", "type": "array", "items": { "type": "string" } }, - "currentCopyrightOwnerIdentifier": { - "title": "Current Copyright Owner ID {Artwork or Object detail}", - "description": "Globally unique identifier for the current owner of the copyright of the artwork or object.", - "type": "string", - "format": "uri" - }, - "currentCopyrightOwnerName": { - "title": "Current Copyright Owner Name {Artwork or Object detail}", - "description": "Name of the current owner of the copyright of the artwork or object.", - "type": "string" - }, - "currentLicensorIdentifier": { - "title": "Current Licensor ID {Artwork or Object detail}", - "description": "Globally unique identifier for the current licensor of the artwork or object.", - "type": "string", - "format": "uri" - }, - "currentLicensorName": { - "title": "Current Licensor Name {Artwork or Object detail}", - "description": "Name of the current licensor of the artwork or object.", - "type": "string" - }, "dateCreated": { "title": "Date Created {Artwork or Object detail}", "description": "Designates the date and optionally the time the artwork or object in the image was created. This relates to artwork or objects with associated intellectual property rights.", "type": "string", "format": "date-time" }, - "physicalDescription": { - "$ref": "#/definitions/AltLang", - "description": "A textual description of the physical characteristics of the artwork or object, without reference to the content depicted.", - "title": "Physical Description {Artwork or Object detail}" + "circaDateCreated": { + "title": "Circa Date Created {Artwork or Object detail}", + "description": "Approximate date or range of dates associated with the creation and production of an artwork or object or its components.", + "type": "string" }, "source": { "title": "Source {Artwork or Object detail}", @@ -134,19 +120,38 @@ "type": "string", "format": "uri" }, - "stylePeriod": { - "title": "Style Period {Artwork or Object detail}", - "description": "The style, historical or artistic period, movement, group, or school whose characteristics are represented in the artwork or object.", - "type": "array", - "items": { - "type": "string" - } + "currentCopyrightOwnerName": { + "title": "Current Copyright Owner Name {Artwork or Object detail}", + "description": "Name of the current owner of the copyright of the artwork or object.", + "type": "string" + }, + "currentCopyrightOwnerIdentifier": { + "title": "Current Copyright Owner ID {Artwork or Object detail}", + "description": "Globally unique identifier for the current owner of the copyright of the artwork or object.", + "type": "string", + "format": "uri" }, - "title": { + + "copyrightNotice": { "$ref": "#/definitions/AltLang", - "description": "A reference for the artwork or object in the image.", - "title": "Title {Artwork or Object detail}" + "description": "Contains any necessary copyright notice for claiming the intellectual property for artwork or an object in the image and should identify the current owner of the copyright of this work with associated intellectual property rights.", + "title": "Copyright Notice {Artwork or Object detail}" + }, + + + "currentLicensorName": { + "title": "Current Licensor Name {Artwork or Object detail}", + "description": "Name of the current licensor of the artwork or object.", + "type": "string" + }, + + "currentLicensorIdentifier": { + "title": "Current Licensor ID {Artwork or Object detail}", + "description": "Globally unique identifier for the current licensor of the artwork or object.", + "type": "string", + "format": "uri" } + }, "additionalProperties": false }, diff --git a/api-documentation/schemas/iptc-pmd-schema.json b/api-documentation/schemas/iptc-pmd-schema.json index 698869241..279badf4c 100644 --- a/api-documentation/schemas/iptc-pmd-schema.json +++ b/api-documentation/schemas/iptc-pmd-schema.json @@ -74,6 +74,33 @@ "type": "string" } }, + + "sceneCodesLabelled": { + "title": "Scene Codes", + "description": "Describes the scene of a photo content. Specifies one ore more terms from the IPTC \"Scene-NewsCodes\". Each Scene is represented as a string of 6 digits in an unordered list.", + "type": "array", + "items": { + "type": "object", + "properties":{ + "code": { + "title": "Scene Code", + "description": "Scene code as a string of 6 digits", + "type": "string" + }, + "label": { + "title": "Scene Label", + "description": "Label", + "type": "string" + }, + "description": { + "title": "Scene Description", + "description": "Description of the scene", + "type": "string" + } + } + } + }, + "subjectCodes": { "title": "Subject Code", "description": "Specifies one or more Subjects from the IPTC Subject-NewsCodes taxonomy to categorise the image. Each Subject is represented as a string of 8 digits in an unordered list.", @@ -82,6 +109,34 @@ "type": "string" } }, + + + "subjectCodesLabelled": { + "title": "Subject Codes", + "description": "Specifies one or more Subjects from the IPTC Subject-NewsCodes taxonomy to categorise the image. Each Subject is represented as a string of 8 digits in an unordered list.", + "type": "array", + "items": { + "type": "object", + "properties":{ + "code": { + "title": "Subject Code", + "description": "Subject code as a string of 8 digits", + "type": "string" + }, + "label": { + "title": "Subject Label", + "description": "Label", + "type": "string" + }, + "description": { + "title": "Subject Description", + "description": "Description of the scene", + "type": "string" + } + } + } + }, + "creatorNames": { "title": "Creator", "description": "Contains the name of the photographer, but in cases where the photographer should not be identified the name of a company or organisation may be appropriate.", diff --git a/application/models/Variable_model.php b/application/models/Variable_model.php index b97b5e883..164cacb52 100644 --- a/application/models/Variable_model.php +++ b/application/models/Variable_model.php @@ -103,7 +103,7 @@ function chunk_read($sid,$start_uid=0, $limit=100) foreach($variables as $key=>$variable){ $variables[$key]['metadata']=$this->Dataset_model->decode_metadata($variable['metadata']); - $variable=$this->map_variable_fields($variable); + $variables[$key]=$this->map_variable_fields($variables[$key]); } return $variables; @@ -381,7 +381,9 @@ public function insert($sid,$options) } $this->db->insert("variables",$options); - return $this->db->insert_id(); + $insert_id=$this->db->insert_id(); + $this->update_survey_timestamp($sid); + return $insert_id; } public function update($sid,$uid,$options) @@ -415,9 +417,24 @@ public function update($sid,$uid,$options) $this->db->where('sid',$sid); $this->db->where('uid',$uid); $this->db->update("variables",$options); + $this->update_survey_timestamp($sid); return $uid; } + private function update_survey_timestamp($sid,$changed=null) + { + if(!$changed){ + $changed=date("U"); + } + + $options=array( + 'changed'=>$changed + ); + + $this->db->where("id",$sid); + $this->db->update('surveys',$options); + } + public function batch_insert($sid,$variables) { @@ -445,6 +462,7 @@ public function batch_insert($sid,$variables) } $this->db->insert_batch('variables', $variables); + $this->update_survey_timestamp($sid); } @@ -589,13 +607,15 @@ function map_variable_fields($variable) 'var_rec_seg_no'=>'loc_rec_seg_no', ); - foreach($variable['metadata'] as $key=>$value){ - //complex types e.g. repeatable array types - if(array_key_exists($key,$mappings)){ - $variable['metadata'][$mappings[$key]]=$value; - unset($variable['metadata'][$key]); - } - } + if (isset($variable['metadata'])){ + foreach($variable['metadata'] as $key=>$value){ + //complex types e.g. repeatable array types + if(array_key_exists($key,$mappings)){ + $variable['metadata'][$mappings[$key]]=$value; + unset($variable['metadata'][$key]); + } + } + } return $variable; } diff --git a/application/schemas/datafile-schema.json b/application/schemas/datafile-schema.json index 6e1b7e1e4..a74e542ac 100644 --- a/application/schemas/datafile-schema.json +++ b/application/schemas/datafile-schema.json @@ -12,6 +12,11 @@ "type": "string", "title" : "File name" }, + "file_type": { + "type": "string", + "title" : "File type", + "description": "Types of data files include raw data (ASCII, EBCDIC, etc.) and software-dependent files such as SAS datasets, SPSS export files, etc." + }, "description": { "type": "string", "title": "File description" diff --git a/application/schemas/ddi-schema.json b/application/schemas/ddi-schema.json index c3dfa6cfb..4fc2d3e02 100644 --- a/application/schemas/ddi-schema.json +++ b/application/schemas/ddi-schema.json @@ -1325,21 +1325,17 @@ "items": { "type": "object", "properties": { - "data_processing": { - "title": "Data processing", - "type": "string" - }, - "source": { - "title": "Source", - "type": "string" - }, "type": { "title": "Data processing type", "type": "string" + }, + "description": { + "title": "Data processing description", + "type": "string" } }, "required": [ - "data_processing" + "description" ] } }, @@ -1372,8 +1368,8 @@ "type": "string", "_ddi_xpath": "stdyDscr/method/codingInstructions/command" }, - "command_language": { - "title": "Language of the command code", + "formal_language": { + "title": "Identify the language of the command code", "description": "Identifies the language of the command code. e.g. `SPSS`, `R`, `STATA` ", "type": "string", "_ddi_xpath": "stdyDscr/method/codingInstructions/command/@formalLanguage" diff --git a/application/schemas/geospatial-schema.json b/application/schemas/geospatial-schema.json index 0a045dbe6..67d68df1a 100644 --- a/application/schemas/geospatial-schema.json +++ b/application/schemas/geospatial-schema.json @@ -2030,7 +2030,8 @@ }, "additional": { "title": "Additional metadata", - "description": "Any additional metadata" + "description": "Any additional metadata", + "type":"object" } }, "required": [ diff --git a/application/schemas/iptc-phovidmdshared-schema.json b/application/schemas/iptc-phovidmdshared-schema.json index 065fd2733..52014c8a1 100644 --- a/application/schemas/iptc-phovidmdshared-schema.json +++ b/application/schemas/iptc-phovidmdshared-schema.json @@ -49,25 +49,28 @@ "ArtworkOrObject": { "type": "object", "properties": { - "circaDateCreated": { - "title": "Circa Date Created {Artwork or Object detail}", - "description": "Approximate date or range of dates associated with the creation and production of an artwork or object or its components.", - "type": "string" + "title": { + "$ref": "#/definitions/AltLang", + "description": "A reference for the artwork or object in the image.", + "title": "Title {Artwork or Object detail}" }, "contentDescription": { "$ref": "#/definitions/AltLang", "description": "A textual description of the content depicted in the artwork or object.", "title": "Content Description {Artwork or Object detail}" }, - "contributionDescription": { + "physicalDescription": { "$ref": "#/definitions/AltLang", - "description": "A textual description about a contribution made to an artwork or an object.", - "title": "Contribution Description {Artwork or Object detail}" + "description": "A textual description of the physical characteristics of the artwork or object, without reference to the content depicted.", + "title": "Physical Description {Artwork or Object detail}" }, - "copyrightNotice": { - "$ref": "#/definitions/AltLang", - "description": "Contains any necessary copyright notice for claiming the intellectual property for artwork or an object in the image and should identify the current owner of the copyright of this work with associated intellectual property rights.", - "title": "Copyright Notice {Artwork or Object detail}" + "creatorNames": { + "title": "Creator {Artwork or Object detail}", + "description": "Contains the name of the artist who has created artwork or an object in the image. In cases where the artist could or should not be identified the name of a company or organisation may be appropriate.", + "type": "array", + "items": { + "type": "string" + } }, "creatorIdentifiers": { "title": "Creator ID {Artwork or Object detail}", @@ -77,46 +80,29 @@ "type": "string" } }, - "creatorNames": { - "title": "Creator {Artwork or Object detail}", - "description": "Contains the name of the artist who has created artwork or an object in the image. In cases where the artist could or should not be identified the name of a company or organisation may be appropriate.", + "contributionDescription": { + "$ref": "#/definitions/AltLang", + "description": "A textual description about a contribution made to an artwork or an object.", + "title": "Contribution Description {Artwork or Object detail}" + }, + "stylePeriod": { + "title": "Style Period {Artwork or Object detail}", + "description": "The style, historical or artistic period, movement, group, or school whose characteristics are represented in the artwork or object.", "type": "array", "items": { "type": "string" } }, - "currentCopyrightOwnerIdentifier": { - "title": "Current Copyright Owner ID {Artwork or Object detail}", - "description": "Globally unique identifier for the current owner of the copyright of the artwork or object.", - "type": "string", - "format": "uri" - }, - "currentCopyrightOwnerName": { - "title": "Current Copyright Owner Name {Artwork or Object detail}", - "description": "Name of the current owner of the copyright of the artwork or object.", - "type": "string" - }, - "currentLicensorIdentifier": { - "title": "Current Licensor ID {Artwork or Object detail}", - "description": "Globally unique identifier for the current licensor of the artwork or object.", - "type": "string", - "format": "uri" - }, - "currentLicensorName": { - "title": "Current Licensor Name {Artwork or Object detail}", - "description": "Name of the current licensor of the artwork or object.", - "type": "string" - }, "dateCreated": { "title": "Date Created {Artwork or Object detail}", "description": "Designates the date and optionally the time the artwork or object in the image was created. This relates to artwork or objects with associated intellectual property rights.", "type": "string", "format": "date-time" }, - "physicalDescription": { - "$ref": "#/definitions/AltLang", - "description": "A textual description of the physical characteristics of the artwork or object, without reference to the content depicted.", - "title": "Physical Description {Artwork or Object detail}" + "circaDateCreated": { + "title": "Circa Date Created {Artwork or Object detail}", + "description": "Approximate date or range of dates associated with the creation and production of an artwork or object or its components.", + "type": "string" }, "source": { "title": "Source {Artwork or Object detail}", @@ -134,19 +120,38 @@ "type": "string", "format": "uri" }, - "stylePeriod": { - "title": "Style Period {Artwork or Object detail}", - "description": "The style, historical or artistic period, movement, group, or school whose characteristics are represented in the artwork or object.", - "type": "array", - "items": { - "type": "string" - } + "currentCopyrightOwnerName": { + "title": "Current Copyright Owner Name {Artwork or Object detail}", + "description": "Name of the current owner of the copyright of the artwork or object.", + "type": "string" + }, + "currentCopyrightOwnerIdentifier": { + "title": "Current Copyright Owner ID {Artwork or Object detail}", + "description": "Globally unique identifier for the current owner of the copyright of the artwork or object.", + "type": "string", + "format": "uri" }, - "title": { + + "copyrightNotice": { "$ref": "#/definitions/AltLang", - "description": "A reference for the artwork or object in the image.", - "title": "Title {Artwork or Object detail}" + "description": "Contains any necessary copyright notice for claiming the intellectual property for artwork or an object in the image and should identify the current owner of the copyright of this work with associated intellectual property rights.", + "title": "Copyright Notice {Artwork or Object detail}" + }, + + + "currentLicensorName": { + "title": "Current Licensor Name {Artwork or Object detail}", + "description": "Name of the current licensor of the artwork or object.", + "type": "string" + }, + + "currentLicensorIdentifier": { + "title": "Current Licensor ID {Artwork or Object detail}", + "description": "Globally unique identifier for the current licensor of the artwork or object.", + "type": "string", + "format": "uri" } + }, "additionalProperties": false }, diff --git a/application/schemas/iptc-pmd-schema.json b/application/schemas/iptc-pmd-schema.json index 698869241..279badf4c 100644 --- a/application/schemas/iptc-pmd-schema.json +++ b/application/schemas/iptc-pmd-schema.json @@ -74,6 +74,33 @@ "type": "string" } }, + + "sceneCodesLabelled": { + "title": "Scene Codes", + "description": "Describes the scene of a photo content. Specifies one ore more terms from the IPTC \"Scene-NewsCodes\". Each Scene is represented as a string of 6 digits in an unordered list.", + "type": "array", + "items": { + "type": "object", + "properties":{ + "code": { + "title": "Scene Code", + "description": "Scene code as a string of 6 digits", + "type": "string" + }, + "label": { + "title": "Scene Label", + "description": "Label", + "type": "string" + }, + "description": { + "title": "Scene Description", + "description": "Description of the scene", + "type": "string" + } + } + } + }, + "subjectCodes": { "title": "Subject Code", "description": "Specifies one or more Subjects from the IPTC Subject-NewsCodes taxonomy to categorise the image. Each Subject is represented as a string of 8 digits in an unordered list.", @@ -82,6 +109,34 @@ "type": "string" } }, + + + "subjectCodesLabelled": { + "title": "Subject Codes", + "description": "Specifies one or more Subjects from the IPTC Subject-NewsCodes taxonomy to categorise the image. Each Subject is represented as a string of 8 digits in an unordered list.", + "type": "array", + "items": { + "type": "object", + "properties":{ + "code": { + "title": "Subject Code", + "description": "Subject code as a string of 8 digits", + "type": "string" + }, + "label": { + "title": "Subject Label", + "description": "Label", + "type": "string" + }, + "description": { + "title": "Subject Description", + "description": "Description of the scene", + "type": "string" + } + } + } + }, + "creatorNames": { "title": "Creator", "description": "Contains the name of the photographer, but in cases where the photographer should not be identified the name of a company or organisation may be appropriate.", diff --git a/application/schemas/table-schema.json b/application/schemas/table-schema.json index 983a7517a..f7d52e318 100644 --- a/application/schemas/table-schema.json +++ b/application/schemas/table-schema.json @@ -454,9 +454,30 @@ "items": { "type": "object", "properties": { - "source": { - "title": "Source", + "name": { + "title": "Name", + "type": "string", + "description": "The name (title) of the data source. For example, a table data may be extracted from the `Population Census 2020`." + }, + "abbreviation": { + "title": "Abbreviation", + "description":"The abbreviation (acronym) of the data source.", + "type": "string" + }, + "source_id": { + "title": "Source ID", + "description":"A unique identifier for the source, such as a Digital Object Identifier (DOI).", "type": "string" + }, + "note": { + "title": "Note", + "type": "string", + "description":"A note that describes how the source was used, possibly mentioning issues in the use of the source." + }, + "uri": { + "title": "URI", + "type": "string", + "description":"A link (URL) to the source dataset." } } } @@ -621,9 +642,36 @@ "themes":{ "type":"array", "description":"Themes", - "allOf": [ - {"$ref":"#/definitions/keyword"} - ] + "items": { + "type": "object", + "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, + "name": { + "title": "Name", + "type": "string" + }, + "parent_id": { + "title": "Parent Identifier", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Name of the controlled vocabulary", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the theme is from a taxonomy.", + "type": "string" + } + }, + "required": [ + "name" + ] + } }, "topics": { "type": "array", @@ -669,10 +717,19 @@ "items": { "type": "object", "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, "name": { "title": "Discipline title or name", "type": "string" }, + "parent_id": { + "title": "Parent discipline Identifier", + "description":"Parent discipline ID", + "type": "string" + }, "vocabulary": { "title": "Vocabulary", "description": "Vocabulary", @@ -786,6 +843,12 @@ "title":"Confidentiality" }, + "sdc": { + "type": "string", + "title":"Statistical disclosure control", + "description":"Information on statistical disclosure control measures applied to the table. This can include cell suppression, or other techniques. Specialized packages have been developed for this purpose, like [*sdcTable: Methods for Statistical Disclosure Control in Tabular Data*](https://cran.r-project.org/web/packages/sdcTable/index.html) and https://cran.r-project.org/web/packages/sdcTable/sdcTable.pdf \nThe information provided here should be such that it does not provide intruders with useful information for reverse-engineering the protection measures applied to the table." + }, + "contacts": { "type": "array", "title": "Contacts", diff --git a/application/schemas/timeseries-db-schema.json b/application/schemas/timeseries-db-schema.json index e7ac76a92..c9c9116f1 100644 --- a/application/schemas/timeseries-db-schema.json +++ b/application/schemas/timeseries-db-schema.json @@ -498,6 +498,11 @@ ] }, + "acknowledgement_statement": { + "title": "An overall statement of acknowledgment, which can be used as an alternative (or supplement) to the itemized list provided in `acknowledgments`.", + "type": "string" + }, + "contacts": { "type": "array", "title": "Contacts", diff --git a/application/schemas/timeseries-schema.json b/application/schemas/timeseries-schema.json index 3c0fc41e2..763a9d330 100644 --- a/application/schemas/timeseries-schema.json +++ b/application/schemas/timeseries-schema.json @@ -794,10 +794,10 @@ "additionalProperties": false } }, - "word_vectors":{ + "embeddings":{ "type": "array", - "title": "Word vectors", - "description": "Word vectors", + "title": "Word embeddings", + "description": "Word embeddings", "items": { "type": "object", "properties": { @@ -834,6 +834,11 @@ "type": "string", "title": "Name" }, + "description": { + "type": "string", + "title": "Description", + "description":"A brief description of the series group." + }, "version": { "type": "string", "title": "Version" diff --git a/application/schemas/variable-schema.json b/application/schemas/variable-schema.json index cc34ef167..9d887e678 100644 --- a/application/schemas/variable-schema.json +++ b/application/schemas/variable-schema.json @@ -57,8 +57,16 @@ }, "var_imputation": { "type": "string", - "title": "Imputation" + "title": "Imputation", + "description": "According to the Statistical Terminology glossary maintained by the National Science Foundation, this is `the process by which one estimates missing values for items that a survey respondent failed to provide,` and if applicable in this context, it refers to the type of procedure used. " }, + + "var_derivation": { + "type": "string", + "title": "Derivation", + "description": "Used only in the case of a derived variable, this element provides both a description of how the derivation was performed and the command used to generate the derived variable, as well as a specification of the other variables in the study used to generate the derivation. The `var` attribute provides the ID values of the other variables in the study used to generate this derived variable." + }, + "var_security": { "type": "string", "title": "Security" @@ -80,6 +88,19 @@ "type": "string", "title": "Post-question text" }, + + "var_forward": { + "type": "string", + "title": "Forward skip", + "description":"Contains a reference to IDs of possible following questions. This can be used to document forward skip instructions." + }, + + "var_backward": { + "type": "string", + "title": "Backward skip", + "description":"Contains a reference to IDs of possible preceding questions. This can be used to document backward skip instructions." + }, + "var_qstn_ivulnstr": { "type": "string", "title": "Interviewer instructions" @@ -155,6 +176,31 @@ } } }, + + "var_std_catgry": { + "type": "object", + "title": "Standard categories", + "description":"Standard category codes used in the variable, like industry codes, employment codes, or social class codes. The attribute `date` is provided to indicate the version of the code in place at the time of the study. The attribute `URI` is provided to indicate a URN or URL that can be used to obtain an electronic list of the category codes.", + "properties":{ + "name": { + "title": "Standard classification name", + "type": "string" + }, + "source": { + "title": "Source", + "type": "string" + }, + "date": { + "title": "Date", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "var_codinstr": { "type": "string", "title": "Recoding and derivation" @@ -196,9 +242,9 @@ "type": "string", "title": "Name" }, - "value": { + "note": { "type": "string", - "title": "Value" + "title": "Note" } } }, From 559a93021b0425f93eca9eb3f85682afb37109bc Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Tue, 15 Feb 2022 13:53:43 +0500 Subject: [PATCH 11/79] add support for whitelisting users to access data by collections --- application/config/data_access.php | 2 +- application/controllers/Study.php | 10 +- .../admin/Dataaccess_whitelist.php | 58 ++++++++ .../controllers/api/Dataaccess_whitelist.php | 132 ++++++++++++++++++ .../models/Data_access_whitelist_model.php | 126 +++++++++++++++++ application/models/Survey_resource_model.php | 38 +++-- .../views/dataaccess_whitelist/index.php | 63 +++++++++ install/schema.mysql.sql | 9 ++ install/schema.sqlsrv.sql | 10 ++ 9 files changed, 437 insertions(+), 11 deletions(-) create mode 100644 application/controllers/admin/Dataaccess_whitelist.php create mode 100644 application/controllers/api/Dataaccess_whitelist.php create mode 100644 application/models/Data_access_whitelist_model.php create mode 100644 application/views/dataaccess_whitelist/index.php diff --git a/application/config/data_access.php b/application/config/data_access.php index 9f1671335..b55c7d9ea 100644 --- a/application/config/data_access.php +++ b/application/config/data_access.php @@ -42,7 +42,7 @@ */ $config['data_access_options'] = array( 'public'=> array( - 'cc40', 'open', 'direct','public','licensed','remote', 'data_na' + 'cc40', 'open', 'direct','public','licensed','remote', 'data_na','data_enclave' ), 'official'=> array( 'research_license','data_na' diff --git a/application/controllers/Study.php b/application/controllers/Study.php index 10ceabe17..7a18b4305 100644 --- a/application/controllers/Study.php +++ b/application/controllers/Study.php @@ -301,7 +301,7 @@ public function related_datasets($sid) public function get_microdata($sid) - { + { $this->load->model("Form_model"); $form_obj=$this->Form_model->get_form_by_survey($sid); @@ -329,6 +329,14 @@ public function get_microdata($sid) $content="Data Access Not Available"; } + $user=$this->ion_auth->current_user(); + $this->load->model("Data_access_whitelist_model"); + $user_whitelisted=$this->Data_access_whitelist_model->has_access($user->id,$sid); + + if($user_whitelisted){ + $content=$this->Data_access_whitelist_model->get_data_files($sid); + } + $this->render_page($sid, $content,'get_microdata'); } diff --git a/application/controllers/admin/Dataaccess_whitelist.php b/application/controllers/admin/Dataaccess_whitelist.php new file mode 100644 index 000000000..d1b4a1804 --- /dev/null +++ b/application/controllers/admin/Dataaccess_whitelist.php @@ -0,0 +1,58 @@ +template->set_template('admin5'); + $this->load->model("Data_access_whitelist_model"); + $this->load->model("Repository_model"); + $this->load->helper(array ('querystring_helper','url', 'form') ); + $this->load->library( array('acl_manager','form_validation','pagination') ); + + $this->lang->load('general'); + //$this->output->enable_profiler(TRUE); + } + + function index() + { + $this->acl_manager->has_access_or_die('citation', 'view'); + $options['rows']=$this->Data_access_whitelist_model->select_all(); + $options['collections']=$this->Repository_model->list_all(); + + $content=$this->load->view('dataaccess_whitelist/index', $options,true); + $this->template->write('title', t('Data access whitelist'),true); + $this->template->write('content', $content,true); + $this->template->render(); + } + + + function create() + { + $user_id=$this->Data_access_whitelist_model->get_user_id($this->input->post("email")); + $repository_id=$this->input->post("repository_id"); + + if(!$repository_id || !$user_id){ + $this->session->set_flashdata('error', t('Invalid values for `collection_name` or `email`')); + redirect("admin/dataaccess_whitelist","refresh"); + } + + $result=$this->Data_access_whitelist_model->insert($repository_id,$user_id); + + $this->session->set_flashdata('message', t('form_update_success')); + redirect("admin/dataaccess_whitelist","refresh"); + } + + + function delete($id) + { + $this->Data_access_whitelist_model->delete_by_id($id); + $this->session->set_flashdata('message', t('form_update_success')); + redirect("admin/dataaccess_whitelist","refresh"); + } + + +} +/* End of file Dataaccess_whitelist.php */ +/* Location: ./controllers/admin/Dataaccess_whitelist.php */ diff --git a/application/controllers/api/Dataaccess_whitelist.php b/application/controllers/api/Dataaccess_whitelist.php new file mode 100644 index 000000000..e71d09a28 --- /dev/null +++ b/application/controllers/api/Dataaccess_whitelist.php @@ -0,0 +1,132 @@ +load->helper("date"); + $this->load->model('Dataset_model'); + $this->load->model("Survey_resource_model"); + $this->load->model("Data_access_whitelist_model"); + $this->is_admin_or_die(); + } + + //override authentication to support both session authentication + api keys + function _auth_override_check() + { + if ($this->session->userdata('user_id')){ + return true; + } + + parent::_auth_override_check(); + } + + + /** + * + * List + * + **/ + function index_get() + { + try{ + $result=$this->Data_access_whitelist_model->select_all(); + + $response=array( + 'status'=>'success', + 'result'=>$result + ); + + $this->set_response($response, REST_Controller::HTTP_OK); + } + catch(Exception $e){ + $this->set_response($e->getMessage(), REST_Controller::HTTP_BAD_REQUEST); + } + } + + + /** + * + * + * Create + * + * + */ + function index_post() + { + try{ + $options=$this->raw_json_input(); + + $collection_name=isset($options['collection_name']) ? $options['collection_name'] :null; + $email=isset($options['email']) ? $options['email'] : null; + + $repository_id=$this->Data_access_whitelist_model->get_repo_id($collection_name); + $user_id=$this->Data_access_whitelist_model->get_user_id($email); + + if(!$repository_id || !$user_id){ + throw new Exception("Invalid values for `collection_name` or `email`"); + } + + $result=$this->Data_access_whitelist_model->insert($repository_id,$user_id); + + $output=array( + 'status'=>'success', + 'result'=>$result + ); + $this->set_response($output, REST_Controller::HTTP_OK); + } + catch(Exception $e){ + $error_output=array( + 'status'=>'failed', + 'message'=>$e->getMessage() + ); + $this->set_response($error_output, REST_Controller::HTTP_BAD_REQUEST); + } + } + + + function index_delete() + { + try{ + + $options=$this->raw_json_input(); + + $collection_name=isset($options['collection_name']) ? $options['collection_name'] :null; + $email=isset($options['email']) ? $options['email'] : null; + + $repository_id=$this->Data_access_whitelist_model->get_repo_id($collection_name); + $user_id=$this->Data_access_whitelist_model->get_user_id($email); + + if(!$repository_id || !$user_id){ + throw new Exception("Invalid values for `collection_name` or `email`"); + } + + $result=$this->Data_access_whitelist_model->delete($repository_id,$user_id); + + $response=array( + 'status'=>'success', + 'message'=>'DELETED', + 'result'=>$result + ); + + $this->set_response($response, REST_Controller::HTTP_OK); + } + catch(Exception $e){ + $error_output=array( + 'status'=>'failed', + 'message'=>$e->getMessage() + ); + $this->set_response($error_output, REST_Controller::HTTP_BAD_REQUEST); + } + } + + +} diff --git a/application/models/Data_access_whitelist_model.php b/application/models/Data_access_whitelist_model.php new file mode 100644 index 000000000..feef90d0b --- /dev/null +++ b/application/models/Data_access_whitelist_model.php @@ -0,0 +1,126 @@ +output->enable_profiler(TRUE); + $this->load->model("Repository_model"); + } + + + function select_all() + { + $this->db->select("data_access_whitelist.id,repositories.id as collection_id,repositories.repositoryid as collection_name, users.id as user_id,users.email, users.username"); + $this->db->join('repositories', 'repositories.id= data_access_whitelist.repository_id'); + $this->db->join('users', 'users.id= data_access_whitelist.user_id'); + $result=$this->db->get('data_access_whitelist')->result_array(); + + return $result; + } + + function has_access($userid,$sid) + { + //get repository id from study + $this->db->select("repositoryid"); + $this->db->where("id",$sid); + $study=$this->db->get("surveys")->row_array(); + + if(!$study){ + return false; + } + + $repoid=$study['repositoryid']; + $repository_uid=$this->Repository_model->get_repositoryid_uid($repoid); + + //check + $this->db->select("*"); + $this->db->where("user_id",$userid); + $this->db->where("repository_id",$repository_uid); + $result=$this->db->get("data_access_whitelist")->row_array(); + + if(!$result){ + return false; + } + + return true; + } + + + function get_data_files($sid) + { + $this->load->model('Survey_resource_model'); + $result['resources_microdata']=$this->Survey_resource_model->get_microdata_resources($sid); + $result['sid']=$sid; + $result['storage_path']=$this->Dataset_model->get_storage_fullpath($sid); + return $this->load->view('catalog_search/survey_summary_microdata', $result,TRUE); + } + + + function insert($repository_id, $user_id) + { + if ($this->row_exists($repository_id,$user_id)){ + throw new Exception("User is already whitelisted"); + } + + $data=array( + 'user_id'=>$user_id, + 'repository_id'=>$repository_id + ); + + $result=$this->db->insert('data_access_whitelist', $data); + + if ($result===false){ + throw new MY_Exception($this->db->_error_message()); + } + + return $this->db->insert_id(); + } + + function row_exists($repository_id,$user_id) + { + $this->db->select("*"); + $this->db->where('repository_id', $repository_id); + $result=$this->db->get("data_access_whitelist")->result_array(); + + if ($result) + { + return true; + } + + return false; + } + + + function delete($repository_id,$user_id) + { + $this->db->where('repository_id', $repository_id); + $this->db->where('user_id', $user_id); + return $this->db->delete('data_access_whitelist'); + } + + function delete_by_id($id) + { + $this->db->where('id', $id); + return $this->db->delete('data_access_whitelist'); + } + + + function get_repo_id($collection_name){ + return $this->Repository_model->get_repositoryid_uid($collection_name); + } + + function get_user_id($email) + { + $this->db->select("id"); + $this->db->where("email",$email); + $result=$this->db->get("users")->row_array(); + + if ($result){ + return $result['id']; + } + + return false; + } + +} diff --git a/application/models/Survey_resource_model.php b/application/models/Survey_resource_model.php index 162e7a0fa..d8141ae7f 100644 --- a/application/models/Survey_resource_model.php +++ b/application/models/Survey_resource_model.php @@ -804,14 +804,7 @@ function get_user_download_access_info($user_id,$survey_id,$resource_obj) } } - return array( - 'access'=>false, - 'is_microdata'=>true, - 'license'=>$data_access_type, - 'access_request'=>$req, - 'error'=>'expired' - ); - + return false; break; case 'public': @@ -842,6 +835,31 @@ function get_user_download_access_info($user_id,$survey_id,$resource_obj) } + function whitelist_download($user_id,$survey_id,$resource) + { + $this->load->model("Data_access_whitelist_model"); + $user_whitelisted=$this->Data_access_whitelist_model->has_access($user_id,$survey_id); + + if(!$user_whitelisted){ + return false; + } + + $resource_path=$this->get_resource_download_path($resource['resource_id']); + + if (!file_exists($resource_path)){ + throw new Exception ('RESOURCE_FILE_NOT_FOUND'); + } + + $is_microdata=$this->is_microdata_resource($resource); + + $this->load->helper('download'); + log_message('info','Downloading file '.$resource_path.''); + $this->db_logger->write_log('download',basename($resource_path),($is_microdata ? 'microdata': 'resource'),$survey_id); + $this->db_logger->increment_study_download_count($survey_id); + force_download2($resource_path); + } + + function download($user,$survey_id,$resource_id) { //get resource @@ -852,7 +870,9 @@ function download($user,$survey_id,$resource_id) } $user_id=isset($user->id) ? $user->id : false; - + + $this->whitelist_download($user_id,$survey_id,$resource); + $download_req=$this->get_user_download_access_info($user_id,$survey_id,$resource); if (!$download_req){ diff --git a/application/views/dataaccess_whitelist/index.php b/application/views/dataaccess_whitelist/index.php new file mode 100644 index 000000000..947fb718c --- /dev/null +++ b/application/views/dataaccess_whitelist/index.php @@ -0,0 +1,63 @@ +' : '';?> + +session->flashdata('error');?> +'.$error.'

' : '';?> + + +

+ + + + 'form mt-4') ); ?> +
+
+
+ + +
+
+
+
+ + +
+
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
EmailCollection
+ +
+ + + + + \ No newline at end of file diff --git a/install/schema.mysql.sql b/install/schema.mysql.sql index af7c39648..801a1fb1d 100644 --- a/install/schema.mysql.sql +++ b/install/schema.mysql.sql @@ -1486,3 +1486,12 @@ CREATE TABLE `survey_facets` ( `term_id` int(11) DEFAULT NULL, PRIMARY KEY (`id`) ) AUTO_INCREMENT=1 DEFAULT CHARSET=utf8; + + + +CREATE TABLE `data_access_whitelist` ( + `id` int NOT NULL AUTO_INCREMENT, + `user_id` int DEFAULT NULL, + `repository_id` int DEFAULT NULL, + PRIMARY KEY (`id`) +) AUTO_INCREMENT=1; diff --git a/install/schema.sqlsrv.sql b/install/schema.sqlsrv.sql index 496db2c46..33232c835 100644 --- a/install/schema.sqlsrv.sql +++ b/install/schema.sqlsrv.sql @@ -1519,3 +1519,13 @@ CREATE TABLE user_roles ( insert into user_roles (user_id, role_id) select user_id, group_id from users_groups; + + + + +CREATE TABLE data_access_whitelist ( + id int NOT NULL identity(1,1), + user_id int DEFAULT NULL, + repository_id int DEFAULT NULL, + PRIMARY KEY (id) +); \ No newline at end of file From 6c694e98fd25307109247e211aaec92facf484ea Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Fri, 18 Feb 2022 20:22:02 +0500 Subject: [PATCH 12/79] misc schema updates --- .../catalog-admin/document-schema.json | 29 +- .../catalog-admin/image-schema.json | 26 +- .../catalog-admin/script-schema.json | 142 +- .../catalog-admin/table-schema.json | 407 ++-- .../catalog-admin/timeseries-db-schema.json | 64 +- .../catalog-admin/timeseries-schema.json | 825 ++++---- .../catalog-admin/video-schema.json | 408 +++- application/schemas/document-schema.json | 29 +- application/schemas/image-schema.json | 26 +- application/schemas/table-schema.json | 407 ++-- application/schemas/timeseries-db-schema.json | 64 +- application/schemas/timeseries-schema.json | 1793 +++++++++-------- application/schemas/video-schema.json | 24 +- 13 files changed, 2361 insertions(+), 1883 deletions(-) diff --git a/api-documentation/catalog-admin/document-schema.json b/api-documentation/catalog-admin/document-schema.json index 20d14dd4d..b85794a16 100644 --- a/api-documentation/catalog-admin/document-schema.json +++ b/api-documentation/catalog-admin/document-schema.json @@ -118,17 +118,15 @@ "idno": { "type": "string", "title": "Unique user defined ID", - "description": "The ID number of a dataset is a unique number that is used to identify a particular survey. Define and use a consistent scheme to use. Such an ID could be constructed as follows: country-producer-survey-year-version where \n - country is the 3-letter ISO country abbreviation \n - producer is the abbreviation of the producing agency \n - survey is the survey abbreviation \n - year is the reference year (or the year the survey started) \n - version is the number dataset version number (see Version Description below)" + "description": "The ID number of a dataset is a unique number that is used to identify a document." }, "title": { "type": "string", - "title": "Survey title", - "description": "The title is the official name of the survey as it is stated on the questionnaire or as it appears in the design documents. The following items should be noted:\n - Include the reference year(s) of the survey in the title. \n - Do not include the abbreviation of the survey name in the title. \n - As the survey title is a proper noun, the first letter of each word should be capitalized (except for prepositions or other conjunctions).\n - Including the country name in the title is optional." + "title": "Title" }, "sub_title": { "type": "string", - "title": "Survey subtitle", - "description": "A short subtitle for the survey" + "title": "Subtitle" }, "alternate_title": { "type": "string", @@ -246,27 +244,28 @@ "description": "Date on which document was published." }, - "id_numbers": { + "identifiers": { "type": "array", - "title": "Identifier numbers", - "description": "Numbers e.g. ISSN, ISBN, DOI, etc.", + "title": "Other identifiers", + "description": "Other identifiers", "items": { "type": "object", "properties": { "type": { - "title": "Type", - "description":"ID number type such as ISSN, ISBN, DOI" + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" }, - "value": { - "title": "ID number", - "type": "string" + "identifier": { + "title": "Identifier", + "type": "string" } }, "required": [ - "type","value" + "identifier" ] } - }, + }, "type": { "type": "string", diff --git a/api-documentation/catalog-admin/image-schema.json b/api-documentation/catalog-admin/image-schema.json index 2433a3d91..de8188bf2 100644 --- a/api-documentation/catalog-admin/image-schema.json +++ b/api-documentation/catalog-admin/image-schema.json @@ -188,18 +188,18 @@ ] } } + }, + "provenance":{ + "type":"array", + "description":"Provenance", + "items":{ + "$ref":"provenance-schema.json" + } + }, + "additional": { + "type": "object", + "description": "Additional metadata", + "properties": {} } - }, - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" - } - }, - "additional": { - "type": "object", - "description": "Additional metadata", - "properties": {} - } + } } \ No newline at end of file diff --git a/api-documentation/catalog-admin/script-schema.json b/api-documentation/catalog-admin/script-schema.json index 0a87296ee..b73cac6cf 100644 --- a/api-documentation/catalog-admin/script-schema.json +++ b/api-documentation/catalog-admin/script-schema.json @@ -96,6 +96,28 @@ "title": "Unique user defined ID", "description": "The ID number of a research project is a unique number that is used to identify a particular project. Define and use a consistent scheme to use." }, + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" + }, + "identifier": { + "title": "Identifier", + "type": "string" + } + }, + "required": [ + "identifier" + ] + } + }, "title": { "type": "string", "title": "Project title", @@ -275,19 +297,22 @@ } }, "errata": { - "type": "object", + "type": "array", "title": "Errata", "description": "List of corrected errors in data, scripts or output", - "properties": { - "erratum_date": { - "title": "Date of erratum", - "description": "Date when the erratum was reported or published", - "type": "string" - }, - "erratum_description": { - "title": "Description of the erratum", - "description": "A description of the erratum, with information on which data, scripts, or output were impacted", - "type": "string" + "items": { + "type": "object", + "properties": { + "date": { + "title": "Date of erratum", + "description": "Date when the erratum was reported or published", + "type": "string" + }, + "description": { + "title": "Description of the erratum", + "description": "A description of the erratum, with information on which data, scripts, or output were impacted", + "type": "string" + } } } }, @@ -538,6 +563,18 @@ "description": "Acknowledgement statement", "type": "string" }, + "disclaimer": { + "title": "Disclaimer", + "type": "string" + }, + "confidentiality": { + "title": "Confidentiality", + "type": "string" + }, + "citation_requirement": { + "type": "string", + "description": "Citation requirement (can include a specific recommended citation)" + }, "related_projects": { "type": "array", "title": "Related research projects", @@ -747,6 +784,10 @@ } } }, + "copyright": { + "title": "Copyright", + "type": "string" + }, "technology_environment": { "title": "Technology environment", "description": "Notes about the technology environment used by the authors to implement the project", @@ -808,7 +849,7 @@ }, "additionalProperties": false }, - "required": [ + "required": [ "name" ] }, @@ -996,52 +1037,41 @@ "required": [ "name" ] - }, - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" - } - }, - "tags": { - "type": "array", - "title": "Tags (user-defined)", - "description": "Tags", - "items": { - "type": "object", - "properties": { - "tag": { - "title": "Tag", - "type": "string" - }, - "tag_group": { - "title": "Tag group", - "type": "string" - } - } + } + } + }, + "provenance": { + "type": "array", + "description": "Provenance", + "items": { + "$ref": "provenance-schema.json" + } + }, + "tags": { + "type": "array", + "title": "Tags (user-defined)", + "description": "Tags", + "items": { + "type": "object", + "properties": { + "tag": { + "title": "Tag", + "type": "string" }, - "required": [ - "tag" - ] - }, - "copyright": { - "title": "Copyright", - "type": "string" - }, - "disclaimer": { - "title": "Disclaimer", - "type": "string" - }, - "confidentiality": { - "title": "Confidentiality", - "type": "string" - }, - "citation_requirement": { - "type": "string", - "description": "Citation requirement (can include a specific recommended citation)" + "tag_group": { + "title": "Tag group", + "type": "string" + } } - } + }, + "required": [ + "tag" + ] + }, + "additional": { + "type": "object", + "description": "Additional metadata", + "properties": {} } } } \ No newline at end of file diff --git a/api-documentation/catalog-admin/table-schema.json b/api-documentation/catalog-admin/table-schema.json index f7d52e318..b1c7ad573 100644 --- a/api-documentation/catalog-admin/table-schema.json +++ b/api-documentation/catalog-admin/table-schema.json @@ -3,29 +3,29 @@ "$schema": "http://json-schema.org/draft-07/schema#", "description": "Draft Schema for Table data type", "type": "object", - "definitions":{ - "authoring_entity":{ - "type":"array", - "title":"Authoring entity/Primary investigators", - "description":"The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Agency Name", - "type":"string" + "definitions": { + "authoring_entity": { + "type": "array", + "title": "Authoring entity/Primary investigators", + "description": "The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Agency Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "abbreviation":{ - "title":"Abbreviation", - "type":"string" + "abbreviation": { + "title": "Abbreviation", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" }, "author_id": { "type": "array", @@ -46,90 +46,89 @@ } } }, - "required":[ + "required": [ "name" ] } }, - "contributor":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "contributor": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "abbreviation":{ - "title":"Abbreviation", - "type":"string" + "abbreviation": { + "title": "Abbreviation", + "type": "string" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "keyword":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "keyword": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "vocabulary":{ - "title":"Vocabulary name", - "type":"string" + "vocabulary": { + "title": "Vocabulary name", + "type": "string" }, - "uri":{ - "title":"Vocabulary URI", - "type":"string" + "uri": { + "title": "Vocabulary URI", + "type": "string" } } } } }, - "properties": { - + "properties": { "repositoryid": { "type": "string", "title": "Collection ID that owns the document", "description": "Abbreviation for the collection that owns the document" }, - "published": { "type": "integer", "title": "Status", "description": "Status - 0=draft, 1=published", "default": 0 }, - "overwrite": { "type": "string", - "description": "Overwrite document if already exists?", - "enum":["yes","no"], + "description": "Overwrite document if already exists?", + "enum": [ + "yes", + "no" + ], "default": "no" }, - - "metadata_information": { + "metadata_information": { "type": "object", "title": "Document metadata information", "description": "Document description", - "properties": { + "properties": { "idno": { "title": "Unique ID number for the document", "type": "string" @@ -181,8 +180,7 @@ "type": "object", "title": "Table Description", "description": "Table Description", - "properties": { - + "properties": { "title_statement": { "type": "object", "description": "Title statement", @@ -212,10 +210,9 @@ "title": "Abbreviation or Acronym", "description": "Any form of the title used as a substitute or alternative to the formal title of the resource." }, - "abbreviated_title": { - "title": "Abbreviated Title", - "description": "Title as abbreviated for indexing or identification.", - "type": "string" + "translated_title": { + "title": "Translated title", + "type": "string" } }, "required": [ @@ -223,99 +220,98 @@ "title" ] }, - - "id_numbers": { - "type": "object", - "title": "Identifier numbers", - "description": "Numbers e.g. ISSN, ISBN, DOI, etc.", - "properties": { - "type": { - "title": "Type", - "description":"ID number type such as ISSN, ISBN, DOI", - "type": "string" + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" + }, + "identifier": { + "title": "Identifier", + "type": "string" + } }, - "value": { - "title": "ID number", - "type": "string" - } - }, - "required": [ - "type","value" - ] - }, - + "required": [ + "identifier" + ] + } + }, "authoring_entity": { "title": "Authoring entity", - "$ref":"#/definitions/authoring_entity", + "$ref": "#/definitions/authoring_entity", "description": "Authoring entity" }, "contributors": { "title": "Contributors", - "$ref":"#/definitions/contributor", + "$ref": "#/definitions/contributor", "description": "Contributors" }, - "publisher":{ - "type":"array", - "title":"Publisher", - "description":"Publisher", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" - }, - "affiliation":{ - "title":"Affiliation", - "type":"string" - }, - "abbreviation":{ - "title":"Abbreviation", - "type":"string" - }, - "role":{ - "title":"Role", - "type":"string" - }, - "uri":{ - "title":"URI", - "type":"string" + "publisher": { + "type": "array", + "title": "Publisher", + "description": "Publisher", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "abbreviation": { + "title": "Abbreviation", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, "date_created": { "type": "string", - "title":"Date created", + "title": "Date created", "description": "Date created" }, "date_published": { "type": "string", - "title":"Date published" + "title": "Date published" }, "date_modified": { "type": "string", - "title":"Date last modified", - "description": "Date on which the resource was changed." + "title": "Date last modified", + "description": "Date on which the resource was changed." }, - "version": { "title": "Version", - "type": "string" + "type": "string" }, "description": { "title": "Description", "type": "string", - "description":"Description" + "description": "Description" }, - "table_columns": { "type": "array", "title": "Table column names", - "description": "List of table column names", + "description": "List of table column names", "items": { "type": "object", "properties": { @@ -327,7 +323,7 @@ "title": "Variable name", "description": "Variable name", "type": "string" - }, + }, "dataset": { "title": "Dataset", "type": "string", @@ -339,11 +335,10 @@ ] } }, - "table_rows": { "type": "array", "title": "Table row level data", - "description": "Table row level data", + "description": "Table row level data", "items": { "type": "object", "properties": { @@ -355,7 +350,7 @@ "title": "Variable name", "description": "Variable name", "type": "string" - }, + }, "dataset": { "title": "Dataset", "type": "string", @@ -367,7 +362,6 @@ ] } }, - "table_footnotes": { "type": "array", "title": "Chart footnotes", @@ -377,7 +371,7 @@ "properties": { "number": { "title": "Footnote number", - "description":"Footnote number", + "description": "Footnote number", "type": "string" }, "text": { @@ -388,13 +382,12 @@ "required": [ "text" ] - } + } }, - "table_series": { "type": "array", "title": "Table series", - "description": "Table series", + "description": "Table series", "items": { "type": "object", "properties": { @@ -421,10 +414,9 @@ ] } }, - "statistics": { "type": "array", - "title": "Statistics", + "title": "Statistics", "items": { "type": "object", "properties": { @@ -437,7 +429,7 @@ }, "unit_observation": { "type": "array", - "title": "Unit observation", + "title": "Unit observation", "items": { "type": "object", "properties": { @@ -450,7 +442,7 @@ }, "data_sources": { "type": "array", - "title": "Data sources", + "title": "Data sources", "items": { "type": "object", "properties": { @@ -461,29 +453,27 @@ }, "abbreviation": { "title": "Abbreviation", - "description":"The abbreviation (acronym) of the data source.", + "description": "The abbreviation (acronym) of the data source.", "type": "string" - }, + }, "source_id": { "title": "Source ID", - "description":"A unique identifier for the source, such as a Digital Object Identifier (DOI).", + "description": "A unique identifier for the source, such as a Digital Object Identifier (DOI).", "type": "string" }, "note": { "title": "Note", "type": "string", - "description":"A note that describes how the source was used, possibly mentioning issues in the use of the source." + "description": "A note that describes how the source was used, possibly mentioning issues in the use of the source." }, "uri": { "title": "URI", "type": "string", - "description":"A link (URL) to the source dataset." + "description": "A link (URL) to the source dataset." } } } }, - - "time_periods": { "type": "array", "title": "Time periods", @@ -506,11 +496,10 @@ "from" ] } - }, - + }, "universe": { "type": "array", - "title": "Universe", + "title": "Universe", "items": { "type": "object", "properties": { @@ -521,10 +510,9 @@ } } }, - "ref_country": { "type": "array", - "title": "Reference country", + "title": "Reference country", "items": { "type": "object", "properties": { @@ -539,7 +527,6 @@ } } }, - "geographic_units": { "title": "Geographic locations", "description": "List of geographic units (regions, countries, states, provinces, etc.) for which data are available in the database.", @@ -561,19 +548,43 @@ "title": "Type", "description": "Type of geographic unit e.g. country, state, region, province etc", "type": "string" - } + } }, "required": [ "name" ] } - }, + }, "geographic_granularity": { "description": "Granularity of geographic coverage. examples `national`, `regional`, `provincial`", "type": "string", - "title":"Geographic granularity" + "title": "Geographic granularity" + }, + "bbox": { + "title": "Geographic bounding box", + "type": "array", + "items": { + "type": "object", + "properties": { + "west": { + "title": "West", + "type": "string" + }, + "east": { + "title": "East", + "type": "string" + }, + "south": { + "title": "South", + "type": "string" + }, + "north": { + "title": "North", + "type": "string" + } + } + } }, - "languages": { "type": "array", "description": "languages", @@ -596,10 +607,9 @@ "name" ] }, - "links": { "type": "array", - "title": "Links", + "title": "Links", "items": { "type": "object", "properties": { @@ -614,10 +624,9 @@ } } }, - "publications": { "type": "array", - "title": "Publications", + "title": "Publications", "items": { "type": "object", "properties": { @@ -632,16 +641,18 @@ } } }, - "keywords":{ - "allOf": [ - {"$ref":"#/definitions/keyword"} + "keywords": { + "allOf": [ + { + "$ref": "#/definitions/keyword" + } ], - "title":"Keywords", - "description":"Keywords" + "title": "Keywords", + "description": "Keywords" }, - "themes":{ - "type":"array", - "description":"Themes", + "themes": { + "type": "array", + "description": "Themes", "items": { "type": "object", "properties": { @@ -690,7 +701,7 @@ }, "parent_id": { "title": "Parent topic Identifier", - "description":"For subtopics, provide the ID of the parent topic", + "description": "For subtopics, provide the ID of the parent topic", "type": "string" }, "vocabulary": { @@ -705,11 +716,11 @@ } }, "required": [ - "id","name" + "id", + "name" ] } }, - "disciplines": { "type": "array", "title": "Disciplines", @@ -727,7 +738,7 @@ }, "parent_id": { "title": "Parent discipline Identifier", - "description":"Parent discipline ID", + "description": "Parent discipline ID", "type": "string" }, "vocabulary": { @@ -746,7 +757,6 @@ ] } }, - "definitions": { "type": "array", "title": "Definitions", @@ -774,7 +784,6 @@ ] } }, - "classifications": { "type": "array", "title": "Classifications", @@ -807,16 +816,13 @@ ] } }, - - "rights": { "type": "string", "title": "Rights" }, - "license": { "type": "array", - "title": "License", + "title": "License", "items": { "type": "object", "properties": { @@ -831,24 +837,20 @@ } } }, - "citation": { "type": "string", - "title":"Citation", - "description": "A bibliographic reference for the resource." + "title": "Citation", + "description": "A bibliographic reference for the resource." }, - "confidentiality": { "type": "string", - "title":"Confidentiality" + "title": "Confidentiality" }, - "sdc": { "type": "string", - "title":"Statistical disclosure control", - "description":"Information on statistical disclosure control measures applied to the table. This can include cell suppression, or other techniques. Specialized packages have been developed for this purpose, like [*sdcTable: Methods for Statistical Disclosure Control in Tabular Data*](https://cran.r-project.org/web/packages/sdcTable/index.html) and https://cran.r-project.org/web/packages/sdcTable/sdcTable.pdf \nThe information provided here should be such that it does not provide intruders with useful information for reverse-engineering the protection measures applied to the table." + "title": "Statistical disclosure control", + "description": "Information on statistical disclosure control measures applied to the table. This can include cell suppression, or other techniques. Specialized packages have been developed for this purpose, like [*sdcTable: Methods for Statistical Disclosure Control in Tabular Data*](https://cran.r-project.org/web/packages/sdcTable/index.html) and https://cran.r-project.org/web/packages/sdcTable/sdcTable.pdf \nThe information provided here should be such that it does not provide intruders with useful information for reverse-engineering the protection measures applied to the table." }, - "contacts": { "type": "array", "title": "Contacts", @@ -886,10 +888,9 @@ "name" ] }, - "notes": { "type": "array", - "title": "Notes", + "title": "Notes", "items": { "type": "object", "properties": { @@ -900,7 +901,6 @@ } } }, - "relations": { "type": "array", "title": "Relations", @@ -915,7 +915,7 @@ "type": { "title": "Type", "type": "string", - "enum":[ + "enum": [ "isPartOf", "hasPart", "isVersionOf", @@ -934,19 +934,17 @@ "required": [ "name" ] - } - + } }, "additionalProperties": false }, - - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" + "provenance": { + "type": "array", + "description": "Provenance", + "items": { + "$ref": "provenance-schema.json" } - }, + }, "tags": { "type": "array", "title": "Tags", @@ -968,11 +966,10 @@ "tag" ] }, - "additional": { "type": "object", "description": "Additional metadata", "properties": {} } } -} +} \ No newline at end of file diff --git a/api-documentation/catalog-admin/timeseries-db-schema.json b/api-documentation/catalog-admin/timeseries-db-schema.json index c9c9116f1..b8e30c18b 100644 --- a/api-documentation/catalog-admin/timeseries-db-schema.json +++ b/api-documentation/catalog-admin/timeseries-db-schema.json @@ -5,21 +5,21 @@ "description": "Schema for timeseries database", "type": "object", "properties": { - "published": { "type": "integer", "title": "Status", "description": "0=draft, 1=published", "default": 0 }, - "overwrite": { "type": "string", "description": "Overwrite database if already exists?", - "enum": ["yes", "no"], + "enum": [ + "yes", + "no" + ], "default": "no" }, - "metadata_information": { "type": "object", "title": "Document metadata information", @@ -79,16 +79,36 @@ "title": "Database Description", "description": "Database Description", "properties": { - "title_statement": { "type": "object", "description": "Study title", - "properties": { "idno": { "type": "string", "title": "Unique user defined ID", - "description": "The ID number of a dataset is a unique number that is used to identify a particular survey. Define and use a consistent scheme to use. Such an ID could be constructed as follows: country-producer-survey-year-version where \n - country is the 3-letter ISO country abbreviation \n - producer is the abbreviation of the producing agency \n - survey is the survey abbreviation \n - year is the reference year (or the year the survey started) \n - version is the number dataset version number (see Version Description below)" + "description": "The ID number of a database is a unique number that is used to identify a particular database." + }, + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" + }, + "identifier": { + "title": "Identifier", + "type": "string" + } + }, + "required": [ + "identifier" + ] + } }, "title": { "type": "string", @@ -99,13 +119,11 @@ "type": "string", "title": "Survey subtitle", "description": "A short subtitle for the survey" - }, "alternate_title": { "type": "string", "title": "Abbreviation or Acronym", "description": "The abbreviation of a survey is usually the first letter of each word of the titled survey. The survey reference year(s) may be included." - }, "translated_title": { "title": "Translated Title", @@ -118,7 +136,6 @@ "title" ] }, - "authoring_entity": { "type": "array", "title": "Authoring entity", @@ -130,12 +147,7 @@ "title": "Agency Name", "type": "string", "description": "Name of the person, corporate body, or agency responsible for the work's substantive and intellectual content. If a person, invert first and last name and use commas." - }, - "role": { - "title": "Role", - "type": "string", - "description": "Title of the person (if any) responsible for the work's substantive and intellectual content." - }, + }, "affiliation": { "title": "Affiliation", "type": "string" @@ -147,6 +159,10 @@ "email": { "title": "Email", "description": "Email" + }, + "uri": { + "title": "URI", + "type": "string" } }, "required": [ @@ -210,7 +226,8 @@ } }, "required": [ - "version", "date" + "version", + "date" ] } }, @@ -331,7 +348,8 @@ } }, "required": [ - "id", "name" + "id", + "name" ] } }, @@ -418,18 +436,15 @@ } } }, - "geographic_granularity": { "title": "Geographic granularity", "description": "Granularity of geographic coverage e.g. `national`, `regional`, `provincial`", "type": "string" }, - "geographic_area_count": { "description": "Number of geographic areas", "type": "string" }, - "sponsors": { "type": "array", "title": "Sponsor/Funding Agency", @@ -467,7 +482,6 @@ "name" ] }, - "acknowledgments": { "type": "array", "title": "Other Acknowledgments", @@ -497,12 +511,10 @@ "name" ] }, - "acknowledgement_statement": { "title": "An overall statement of acknowledgment, which can be used as an alternative (or supplement) to the itemized list provided in `acknowledgments`.", "type": "string" }, - "contacts": { "type": "array", "title": "Contacts", @@ -540,7 +552,6 @@ "name" ] }, - "links": { "type": "array", "title": "Related links", @@ -562,7 +573,6 @@ "uri" ] }, - "languages": { "type": "array", "description": "Supported languages", @@ -655,7 +665,6 @@ } } }, - "disclaimer": { "title": "Disclaimer", "type": "string" @@ -670,7 +679,6 @@ ], "additionalProperties": false }, - "additional": { "type": "object", "title": "Additional custom metadata", diff --git a/api-documentation/catalog-admin/timeseries-schema.json b/api-documentation/catalog-admin/timeseries-schema.json index baac06983..2a7e2cf30 100644 --- a/api-documentation/catalog-admin/timeseries-schema.json +++ b/api-documentation/catalog-admin/timeseries-schema.json @@ -1,104 +1,101 @@ { - "$id": "http://ihsn.org/schemas/timeseries", - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Timeseries Schema", - "description": "Schema for timeseries data type", - "type": "object", - "properties": { - - "repositoryid": { - "type": "string", - "title": "Collection ID that owns the series", - "description": "Collection that owns the series" - }, - - "access_policy": { - "type": "string", - "title": "Data access policy", - "description": "Data access policy for attached microdata resources", - "enum": [ - "direct", - "open", - "public", - "licensed", - "remote", - "na" - ], - "default": "na" - }, - - "data_remote_url": { - "type": "string", - "title": "Data website URL", - "description": "Link to the website where the data is available, this is only needed if `access_policy` is set to `remote`." - }, - "published": { - "type": "integer", - "title": "Status", - "description": "Status of the study - 0=draft, 1=published", - "default": 0 - }, - "overwrite": { - "type": "string", - "description": "Overwrite database if already exists?", - "enum":["yes","no"], - "default": "no" - }, - - "metadata_creation": { - "type": "object", - "title": "Metadata creation", - "description": "Information on who generated the documentation", - "properties": { - - "producers": { - "type": "array", - "title": "Producers", - "description": "List of producers", - "items": { - "type": "object", - "properties": { - "name": { - "title": "Name", - "description": "Name (required)", - "type": "string" - }, - "abbr": { - "title": "Abbreviation", - "type": "string" - }, - "affiliation": { - "type": "string", - "title": "Affiliation" - }, - "role": { - "title": "Role", - "type": "string" - } - } - }, - "required": [ - "name" - ] - }, - "prod_date": { - "title": "Date of Production", - "description": "Document production date using format(YYYY-MM-DD)", - "type": "string" - }, - "version": { - "title": "Document version", - "description": "Identify and describe the current version of the document", - "type": "string" - } - }, - "additionalProperties": false - }, - - "series_description":{ - "description" :"Series information", - "type": "object", - "properties": { + "$id": "http://ihsn.org/schemas/timeseries", + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "Timeseries Schema", + "description": "Schema for timeseries data type", + "type": "object", + "properties": { + "repositoryid": { + "type": "string", + "title": "Collection ID that owns the series", + "description": "Collection that owns the series" + }, + "access_policy": { + "type": "string", + "title": "Data access policy", + "description": "Data access policy for attached microdata resources", + "enum": [ + "direct", + "open", + "public", + "licensed", + "remote", + "na" + ], + "default": "na" + }, + "data_remote_url": { + "type": "string", + "title": "Data website URL", + "description": "Link to the website where the data is available, this is only needed if `access_policy` is set to `remote`." + }, + "published": { + "type": "integer", + "title": "Status", + "description": "Status of the study - 0=draft, 1=published", + "default": 0 + }, + "overwrite": { + "type": "string", + "description": "Overwrite database if already exists?", + "enum": [ + "yes", + "no" + ], + "default": "no" + }, + "metadata_creation": { + "type": "object", + "title": "Metadata creation", + "description": "Information on who generated the documentation", + "properties": { + "producers": { + "type": "array", + "title": "Producers", + "description": "List of producers", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Name (required)", + "type": "string" + }, + "abbr": { + "title": "Abbreviation", + "type": "string" + }, + "affiliation": { + "type": "string", + "title": "Affiliation" + }, + "role": { + "title": "Role", + "type": "string" + } + } + }, + "required": [ + "name" + ] + }, + "prod_date": { + "title": "Date of Production", + "description": "Document production date using format(YYYY-MM-DD)", + "type": "string" + }, + "version": { + "title": "Document version", + "description": "Identify and describe the current version of the document", + "type": "string" + } + }, + "additionalProperties": false + }, + "series_description": { + "description": "Series information", + "type": "object", + "properties": { "idno": { "type": "string", "title": "Series unique ID", @@ -162,6 +159,26 @@ "type": "string", "title": "Series unit of measure" }, + "dimensions": { + "type": "array", + "title": "Dimensions", + "items": { + "type": "object", + "properties": { + "label": { + "title": "Label", + "type": "string" + }, + "description": { + "title": "Description", + "type": "string" + } + }, + "required": [ + "label" + ] + } + }, "periodicity": { "type": "string", "title": "Periodicity of data" @@ -205,12 +222,10 @@ ] } }, - "statistical_concept": { "type": "string", "title": "Statistical concept" }, - "concepts": { "type": "array", "title": "Related concepts", @@ -228,10 +243,10 @@ "type": "string" }, "uri": { - "title": "URI", - "description": "Website link", - "type": "string" - } + "title": "URI", + "description": "Website link", + "type": "string" + } }, "required": [ "name" @@ -266,99 +281,94 @@ "type": "string", "title": "Breaks in series" }, - "limitation": { "type": "string", "title": "Limitations and exceptions" - }, - - "themes":{ - "type":"array", - "title":"Themes", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" - }, - "vocabulary":{ - "title":"Vocabulary name", - "type":"string" - }, - "uri":{ - "title":"Vocabulary URI", - "type":"string" + }, + "themes": { + "type": "array", + "title": "Themes", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary name", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "type": "string" } } } }, - "topics": { - "type": "array", - "title": "Topics", - "description": "Topics covered by the table (ideally, the list of topics will be a controlled vocabulary)", - "items": { - "type": "object", - "properties": { - "id": { - "title": "Unique Identifier", - "type": "string" - }, - "name": { - "title": "Topic", - "type": "string" - }, - "parent_id": { - "title": "Parent topic Identifier", - "description":"For subtopics, provide the ID of the parent topic", - "type": "string" - }, - "vocabulary": { - "title": "Vocabulary", - "description": "Name of the controlled vocabulary, if the topic is from a taxonomy.", - "type": "string" - }, - "uri": { - "title": "Vocabulary URI", - "description": "Link to the controlled vocabulary web page, if the topic is from a taxonomy.", - "type": "string" - } - }, - "required": [ - "name" - ] - } - }, - - "disciplines": { - "type": "array", - "title": "Disciplines", - "description": "Disciplines e.g. `Social sciences, economics`, `Natural sciences, biology`", - "items": { - "type": "object", - "properties": { - "name": { - "title": "Discipline title or name", - "type": "string" - }, - "vocabulary": { - "title": "Vocabulary", - "description": "Vocabulary", - "type": "string" - }, - "uri": { - "title": "URI", - "description": "Website link", - "type": "string" - } - }, - "required": [ - "name" - ] - } - }, - - + "topics": { + "type": "array", + "title": "Topics", + "description": "Topics covered by the table (ideally, the list of topics will be a controlled vocabulary)", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, + "name": { + "title": "Topic", + "type": "string" + }, + "parent_id": { + "title": "Parent topic Identifier", + "description": "For subtopics, provide the ID of the parent topic", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Name of the controlled vocabulary, if the topic is from a taxonomy.", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the topic is from a taxonomy.", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + "disciplines": { + "type": "array", + "title": "Disciplines", + "description": "Disciplines e.g. `Social sciences, economics`, `Natural sciences, biology`", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Discipline title or name", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Vocabulary", + "type": "string" + }, + "uri": { + "title": "URI", + "description": "Website link", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, "relevance": { "type": "string", "title": "Relavance" @@ -408,6 +418,31 @@ ] } }, + "bbox": { + "title": "Geographic bounding box", + "type": "array", + "items": { + "type": "object", + "properties": { + "west": { + "title": "West", + "type": "string" + }, + "east": { + "title": "East", + "type": "string" + }, + "south": { + "title": "South", + "type": "string" + }, + "north": { + "title": "North", + "type": "string" + } + } + } + }, "aggregation_method": { "type": "string", "title": "Aggregation method" @@ -480,48 +515,81 @@ } } }, - "sources":{ - "type":"array", - "title":"Sources", - "description":"Sources", + "authoring_entity": { + "type": "array", + "title": "Authoring entity", + "description": "The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", "items": { - "type": "object", - "properties": { - "id": { - "title": "Source ID", - "type": "string" - }, - "name": { - "title": "Name", - "description": "Source name", - "type": "string" - }, - "organization": { - "title": "Organization", - "type": "string" + "type": "object", + "properties": { + "name": { + "title": "Agency Name", + "type": "string", + "description": "Name of the person, corporate body, or agency responsible for the work's substantive and intellectual content. If a person, invert first and last name and use commas." + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "abbreviation": { + "title": "Abbreviation", + "description": "Abbreviation" + }, + "email": { + "title": "Email", + "description": "Email" + }, + "uri": { + "title": "URI", + "type": "string" + } }, - "type": { - "title": "Source type", - "type": "string" + "required": [ + "name" + ] + } + }, + "sources": { + "type": "array", + "title": "Sources", + "description": "Sources", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Source ID", + "type": "string" + }, + "name": { + "title": "Name", + "description": "Source name", + "type": "string" + }, + "organization": { + "title": "Organization", + "type": "string" + }, + "type": { + "title": "Source type", + "type": "string" + }, + "note": { + "title": "Note", + "type": "string" + } }, - "note": { - "title": "Note", - "type": "string" - } - }, - "required": [ - "name" - ] + "required": [ + "name" + ] } - }, - + }, "sources_note": { "type": "string", "title": "Notes form original sources" }, "keywords": { "type": "array", - "description": "Keywords", + "description": "Keywords", "items": { "type": "object", "properties": { @@ -545,7 +613,7 @@ }, "acronyms": { "type": "array", - "description": "Acronyms", + "description": "Acronyms", "items": { "type": "object", "properties": { @@ -563,7 +631,8 @@ } }, "required": [ - "acronym", "expansion" + "acronym", + "expansion" ] } }, @@ -699,130 +768,137 @@ "title": "LDA topics", "description": "LDA topics", "items": { - "type": "object", - "properties": { - "model_info": { - "type": "array", - "title": "Model information", - "items": { - "type": "object", - "properties": { - "source": { - "title": "Source", - "type": "string" - }, - "author": { - "title": "Author", - "type": "string" - }, - "version": { - "title": "Version", - "type": "string" - }, - "model_id": { - "title": "Model Identifier", - "type": "string" - }, - "nb_topics": { - "title": "Number of topics", - "type": "number" - }, - "description": { - "title": "Description", - "type": "string" - }, - "corpus": { - "title": "Corpus name", - "type": "string" - }, - "uri": { - "title": "URI", - "type": "string" - } - } - }, - "required": [ - "model_id" - ] - }, - "topic_description": { - "type": "array", - "title": "Topic information", - "items": { - "type": "object", - "properties": { - "topic_id": { - "title": "Topic identifier", - "type": ["integer", "string"] - }, - "topic_score": { - "title": "Topic score", - "type": ["number", "string"] - }, - "topic_label": { - "title": "Topic label", - "type": "string" - }, - "topic_words": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { "type": "array", - "title": "Topic words", - "description": "Words", + "title": "Topic information", "items": { - "type": "object", - "properties": { - "word": { - "title": "Word", - "type": "string" - }, - "word_weight": { - "title": "Word weight", - "type": "number" + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": [ + "integer", + "string" + ] + }, + "topic_score": { + "title": "Topic score", + "type": [ + "number", + "string" + ] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } } - } }, "required": [ - "word" + "topic_id" ] - } } - }, - "required": [ - "topic_id" - ] - } - }, - "additionalProperties": false + }, + "additionalProperties": false } - }, - "embeddings":{ + }, + "embeddings": { "type": "array", "title": "Word embeddings", - "description": "Word embeddings", + "description": "Word embeddings", "items": { - "type": "object", - "properties": { - "id": { - "title": "Vector Model ID", - "type": "string" - }, - "description": { - "title": "Vector Model Description", - "type": "string" - }, - "date": { - "title": "Date (YYYY-MM-DD)", - "type": "string" - }, - "vector": { - "title": "Vector", - "type": "object" + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } } - } }, "required": [ - "id","vector" + "id", + "vector" ] - }, + }, "series_groups": { "type": "array", "title": "Series groups", @@ -837,7 +913,7 @@ "description": { "type": "string", "title": "Description", - "description":"A brief description of the series group." + "description": "A brief description of the series group." }, "version": { "type": "string", @@ -858,44 +934,43 @@ "idno", "name" ] - - }, - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" - } - }, - "tags": { - "type": "array", - "title": "Tags (user-defined)", - "description": "Tags", - "items": { - "type": "object", - "properties": { - "tag": { - "title": "Tag", - "type": "string" - }, - "tag_group": { - "title": "Tag group", - "type": "string" + }, + "provenance": { + "type": "array", + "description": "Provenance", + "items": { + "$ref": "provenance-schema.json" } - } }, - "required": [ - "tag" - ] - }, - "additional": { - "type": "object", - "title":"Additional custom metadata", - "description": "Any other custom metadata not covered by the schema", - "properties": {} - } - }, - "required": [ - "series_description" - ] - } \ No newline at end of file + "tags": { + "type": "array", + "title": "Tags (user-defined)", + "description": "Tags", + "items": { + "type": "object", + "properties": { + "tag": { + "title": "Tag", + "type": "string" + }, + "tag_group": { + "title": "Tag group", + "type": "string" + } + } + }, + "required": [ + "tag" + ] + }, + "additional": { + "type": "object", + "title": "Additional custom metadata", + "description": "Any other custom metadata not covered by the schema", + "properties": {} + } + }, + "required": [ + "series_description" + ] +} \ No newline at end of file diff --git a/api-documentation/catalog-admin/video-schema.json b/api-documentation/catalog-admin/video-schema.json index 6690084f7..b7c37cd25 100644 --- a/api-documentation/catalog-admin/video-schema.json +++ b/api-documentation/catalog-admin/video-schema.json @@ -87,7 +87,29 @@ "idno": { "type": "string", "title": "Unique video identifier" - }, + }, + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" + }, + "identifier": { + "title": "Identifier", + "type": "string" + } + }, + "required": [ + "identifier" + ] + } + }, "title": { "type": "string", "description": "Title" @@ -104,33 +126,60 @@ "type": "string", "description": "Genre" }, - "keywords": { - "type": "string", - "description": "Keywords" - }, - - "topics":{ + "keywords":{ "type":"array", - "title":"Topic Classification", - "description":"Topic Classification", "items":{ "type":"object", "properties":{ - "topic":{ - "title":"Topic", + "name":{ + "title":"Name", "type":"string" }, - "vocab":{ - "title":"Vocab", + "vocabulary":{ + "title":"Vocabulary name", "type":"string" }, "uri":{ - "title":"URI", + "title":"Vocabulary URI", "type":"string" } + } + } + }, + + "topics": { + "type": "array", + "title": "Topics", + "description": "Topics covered by the table (ideally, the list of topics will be a controlled vocabulary)", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, + "name": { + "title": "Topic", + "type": "string" + }, + "parent_id": { + "title": "Parent topic Identifier", + "description":"For subtopics, provide the ID of the parent topic", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Name of the controlled vocabulary, if the topic is from a taxonomy.", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the topic is from a taxonomy.", + "type": "string" + } }, - "required":[ - "topic" + "required": [ + "name" ] } }, @@ -160,34 +209,40 @@ "description": "Primary entity described in the video" }, - "video_provider": { - "type": "string", - "description": "Video provider e.g. youtube, vimeo, facebook" - }, - - "video_url": { + "date_created": { "type": "string", - "description": "Video URL" + "description": "Date of creation (YYYY-MM-DD)" }, - - "embed_url": { + "date_published": { "type": "string", - "description": "Video embed URL" + "description": "Date published (YYYY-MM-DD)" }, - "encoding_format": { + "version": { "type": "string", - "title":"Encoding format", - "description": "Media type using a MIME format" + "description": "Version" }, - "duration": { + "status": { "type": "string", - "title":"Duration", - "description": "The duration of the video in ISO 8601 date time format - `hh:mm:ss`" + "title":"Creative work status", + "description": "Status of a creative work in terms of its stage in lifecycle. e.g. `incomplete`, `draft`, `published`, `obsolete`" }, - "content_location": { - "type": "string", - "description": "Location depicted or described in the video" + "country": { + "type": "array", + "title": "Countries", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Country name", + "type": "string" + }, + "code": { + "title": "Country code", + "type": "string" + } + } + } }, "spatial_coverage": { @@ -205,39 +260,213 @@ "description": "Period that the content applies to using ISO 8601 date time format" }, + "recorded_at": { + "type": "string", + "description": "Location where video was recorded" + }, + "audience": { "type": "string", "description": "Intended audience" }, - - "country": { - "type": "string", - "description": "Country" + + "bbox": { + "title": "Geographic bounding box", + "type": "array", + "items": { + "type": "object", + "properties": { + "west": { + "title": "West", + "type": "string" + }, + "east": { + "title": "East", + "type": "string" + }, + "south": { + "title": "South", + "type": "string" + }, + "north": { + "title": "North", + "type": "string" + } + } + } }, + "language": { + "type": "array", + "description": "languages", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Language name", + "type": "string" + }, + "code": { + "title": "code", + "Descripton": "Language code", + "type": "string" + } + } + }, + "required": [ + "name" + ] + }, + + "creator": { "type": "string", - "description": "Language" + "description": "Creator" }, - "author": { + + "production_company": { "type": "string", - "description": "Author" + "description": "Production company" }, + "publisher": { "type": "string", "description": "Publisher" }, - "contributor": { + + "repository": { "type": "string", - "description": "Contributor" + "title": "Repository" + }, + + "contributors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "abbreviation": { + "title": "Abbreviation", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + }, + "required": [ + "name" + ] + } }, "funder": { + "type": "array", + "title": "Funding Agency/Sponsor", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Funding Agency/Sponsor", + "type": "string" + }, + "abbr": { + "title": "Abbreviation", + "type": "string" + }, + "grant": { + "title": "Grant Number", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + + "translators": { + "type": "array", + "title": "Translators", + "description": "Translators", + "items": { + "type": "object", + "properties": { + "first_name": { + "title": "First name", + "type": "string" + }, + "initial": { + "title": "Initial", + "type": "string" + }, + "last_name": { + "title": "Last name", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + } + } + }, + "required": [ + "first_name" + ] + }, + + "is_based_on": { + "type": "string", + "title":"A resource from which this work is derived", + "description": "A resource from which this work is derived or from which it is a modification or adaption" + }, + "is_part_of": { + "type": "string", + "title":"Indicate an item that this item is part of" + }, + + "relations": { "type": "string", - "description": "Funder" + "title":"Defines, as a free text field, the relation between the video being documented and other resources. This is a Dublin Core element." }, - "translator": { + + "video_provider": { + "type": "string", + "description": "Video provider e.g. youtube, vimeo, facebook" + }, + + "video_url": { + "type": "string", + "description": "Video URL" + }, + + "embed_url": { "type": "string", - "title": "Translator", - "description": "Organization or person who adapts a creative work to different languages" + "description": "Video embed URL" + }, + "encoding_format": { + "type": "string", + "title":"Encoding format", + "description": "Media type using a MIME format" + }, + "duration": { + "type": "string", + "title":"Duration", + "description": "The duration of the video in ISO 8601 date time format - `hh:mm:ss`" }, "rights": { "type": "string", @@ -261,34 +490,73 @@ "description": "Year during which claimed copyright for the video was first asserted" }, - - - "date_created": { + "credit_text": { "type": "string", - "description": "Date of creation (YYYY-MM-DD)" + "title": "Credits", + "description": "This element that can be used to credit the person(s) and/or organization(s) associated with a published video. It corresponds to the `creditText` element of VideoObject." }, - "date_published": { - "type": "string", - "description": "Date published (YYYY-MM-DD)" - }, - "version": { + + "citation": { "type": "string", - "description": "Version" + "title": "Citation", + "description": "This element provides a required or recommended citation of the audio file." }, - "status": { - "type": "string", - "title":"Creative work status", - "description": "Status of a creative work in terms of its stage in lifecycle. e.g. `incomplete`, `draft`, `published`, `obsolete`" + + "transcript": { + "type": "array", + "title": "Transcript", + "items": { + "type": "object", + "properties": { + "language": { + "title": "Language", + "type": "string" + }, + "text": { + "title": "Text", + "type": "string" + } + } + }, + "required": [ + "text" + ] }, - "is_based_on": { - "type": "string", - "title":"A resource from which this work is derived", - "description": "A resource from which this work is derived or from which it is a modification or adaption" + + "media": { + "type": "array", + "title": "Media", + "items": { + "type": "string" + } }, - "is_part_of": { - "type": "string", - "title":"Indicate an item that this item is part of" - } + + "album": { + "type": "array", + "title": "Album", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name of album", + "type": "string" + }, + "description": { + "title": "Description", + "type": "string" + }, + "owner": { + "title": "Owner", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + } + } + }, "required": [ diff --git a/application/schemas/document-schema.json b/application/schemas/document-schema.json index 20d14dd4d..b85794a16 100644 --- a/application/schemas/document-schema.json +++ b/application/schemas/document-schema.json @@ -118,17 +118,15 @@ "idno": { "type": "string", "title": "Unique user defined ID", - "description": "The ID number of a dataset is a unique number that is used to identify a particular survey. Define and use a consistent scheme to use. Such an ID could be constructed as follows: country-producer-survey-year-version where \n - country is the 3-letter ISO country abbreviation \n - producer is the abbreviation of the producing agency \n - survey is the survey abbreviation \n - year is the reference year (or the year the survey started) \n - version is the number dataset version number (see Version Description below)" + "description": "The ID number of a dataset is a unique number that is used to identify a document." }, "title": { "type": "string", - "title": "Survey title", - "description": "The title is the official name of the survey as it is stated on the questionnaire or as it appears in the design documents. The following items should be noted:\n - Include the reference year(s) of the survey in the title. \n - Do not include the abbreviation of the survey name in the title. \n - As the survey title is a proper noun, the first letter of each word should be capitalized (except for prepositions or other conjunctions).\n - Including the country name in the title is optional." + "title": "Title" }, "sub_title": { "type": "string", - "title": "Survey subtitle", - "description": "A short subtitle for the survey" + "title": "Subtitle" }, "alternate_title": { "type": "string", @@ -246,27 +244,28 @@ "description": "Date on which document was published." }, - "id_numbers": { + "identifiers": { "type": "array", - "title": "Identifier numbers", - "description": "Numbers e.g. ISSN, ISBN, DOI, etc.", + "title": "Other identifiers", + "description": "Other identifiers", "items": { "type": "object", "properties": { "type": { - "title": "Type", - "description":"ID number type such as ISSN, ISBN, DOI" + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" }, - "value": { - "title": "ID number", - "type": "string" + "identifier": { + "title": "Identifier", + "type": "string" } }, "required": [ - "type","value" + "identifier" ] } - }, + }, "type": { "type": "string", diff --git a/application/schemas/image-schema.json b/application/schemas/image-schema.json index 2433a3d91..de8188bf2 100644 --- a/application/schemas/image-schema.json +++ b/application/schemas/image-schema.json @@ -188,18 +188,18 @@ ] } } + }, + "provenance":{ + "type":"array", + "description":"Provenance", + "items":{ + "$ref":"provenance-schema.json" + } + }, + "additional": { + "type": "object", + "description": "Additional metadata", + "properties": {} } - }, - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" - } - }, - "additional": { - "type": "object", - "description": "Additional metadata", - "properties": {} - } + } } \ No newline at end of file diff --git a/application/schemas/table-schema.json b/application/schemas/table-schema.json index f7d52e318..b1c7ad573 100644 --- a/application/schemas/table-schema.json +++ b/application/schemas/table-schema.json @@ -3,29 +3,29 @@ "$schema": "http://json-schema.org/draft-07/schema#", "description": "Draft Schema for Table data type", "type": "object", - "definitions":{ - "authoring_entity":{ - "type":"array", - "title":"Authoring entity/Primary investigators", - "description":"The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Agency Name", - "type":"string" + "definitions": { + "authoring_entity": { + "type": "array", + "title": "Authoring entity/Primary investigators", + "description": "The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Agency Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "abbreviation":{ - "title":"Abbreviation", - "type":"string" + "abbreviation": { + "title": "Abbreviation", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" }, "author_id": { "type": "array", @@ -46,90 +46,89 @@ } } }, - "required":[ + "required": [ "name" ] } }, - "contributor":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "contributor": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "affiliation":{ - "title":"Affiliation", - "type":"string" + "affiliation": { + "title": "Affiliation", + "type": "string" }, - "abbreviation":{ - "title":"Abbreviation", - "type":"string" + "abbreviation": { + "title": "Abbreviation", + "type": "string" }, - "role":{ - "title":"Role", - "type":"string" + "role": { + "title": "Role", + "type": "string" }, - "uri":{ - "title":"URI", - "type":"string" + "uri": { + "title": "URI", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, - "keyword":{ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" + "keyword": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" }, - "vocabulary":{ - "title":"Vocabulary name", - "type":"string" + "vocabulary": { + "title": "Vocabulary name", + "type": "string" }, - "uri":{ - "title":"Vocabulary URI", - "type":"string" + "uri": { + "title": "Vocabulary URI", + "type": "string" } } } } }, - "properties": { - + "properties": { "repositoryid": { "type": "string", "title": "Collection ID that owns the document", "description": "Abbreviation for the collection that owns the document" }, - "published": { "type": "integer", "title": "Status", "description": "Status - 0=draft, 1=published", "default": 0 }, - "overwrite": { "type": "string", - "description": "Overwrite document if already exists?", - "enum":["yes","no"], + "description": "Overwrite document if already exists?", + "enum": [ + "yes", + "no" + ], "default": "no" }, - - "metadata_information": { + "metadata_information": { "type": "object", "title": "Document metadata information", "description": "Document description", - "properties": { + "properties": { "idno": { "title": "Unique ID number for the document", "type": "string" @@ -181,8 +180,7 @@ "type": "object", "title": "Table Description", "description": "Table Description", - "properties": { - + "properties": { "title_statement": { "type": "object", "description": "Title statement", @@ -212,10 +210,9 @@ "title": "Abbreviation or Acronym", "description": "Any form of the title used as a substitute or alternative to the formal title of the resource." }, - "abbreviated_title": { - "title": "Abbreviated Title", - "description": "Title as abbreviated for indexing or identification.", - "type": "string" + "translated_title": { + "title": "Translated title", + "type": "string" } }, "required": [ @@ -223,99 +220,98 @@ "title" ] }, - - "id_numbers": { - "type": "object", - "title": "Identifier numbers", - "description": "Numbers e.g. ISSN, ISBN, DOI, etc.", - "properties": { - "type": { - "title": "Type", - "description":"ID number type such as ISSN, ISBN, DOI", - "type": "string" + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" + }, + "identifier": { + "title": "Identifier", + "type": "string" + } }, - "value": { - "title": "ID number", - "type": "string" - } - }, - "required": [ - "type","value" - ] - }, - + "required": [ + "identifier" + ] + } + }, "authoring_entity": { "title": "Authoring entity", - "$ref":"#/definitions/authoring_entity", + "$ref": "#/definitions/authoring_entity", "description": "Authoring entity" }, "contributors": { "title": "Contributors", - "$ref":"#/definitions/contributor", + "$ref": "#/definitions/contributor", "description": "Contributors" }, - "publisher":{ - "type":"array", - "title":"Publisher", - "description":"Publisher", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" - }, - "affiliation":{ - "title":"Affiliation", - "type":"string" - }, - "abbreviation":{ - "title":"Abbreviation", - "type":"string" - }, - "role":{ - "title":"Role", - "type":"string" - }, - "uri":{ - "title":"URI", - "type":"string" + "publisher": { + "type": "array", + "title": "Publisher", + "description": "Publisher", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "abbreviation": { + "title": "Abbreviation", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" } }, - "required":[ + "required": [ "name" ] } }, "date_created": { "type": "string", - "title":"Date created", + "title": "Date created", "description": "Date created" }, "date_published": { "type": "string", - "title":"Date published" + "title": "Date published" }, "date_modified": { "type": "string", - "title":"Date last modified", - "description": "Date on which the resource was changed." + "title": "Date last modified", + "description": "Date on which the resource was changed." }, - "version": { "title": "Version", - "type": "string" + "type": "string" }, "description": { "title": "Description", "type": "string", - "description":"Description" + "description": "Description" }, - "table_columns": { "type": "array", "title": "Table column names", - "description": "List of table column names", + "description": "List of table column names", "items": { "type": "object", "properties": { @@ -327,7 +323,7 @@ "title": "Variable name", "description": "Variable name", "type": "string" - }, + }, "dataset": { "title": "Dataset", "type": "string", @@ -339,11 +335,10 @@ ] } }, - "table_rows": { "type": "array", "title": "Table row level data", - "description": "Table row level data", + "description": "Table row level data", "items": { "type": "object", "properties": { @@ -355,7 +350,7 @@ "title": "Variable name", "description": "Variable name", "type": "string" - }, + }, "dataset": { "title": "Dataset", "type": "string", @@ -367,7 +362,6 @@ ] } }, - "table_footnotes": { "type": "array", "title": "Chart footnotes", @@ -377,7 +371,7 @@ "properties": { "number": { "title": "Footnote number", - "description":"Footnote number", + "description": "Footnote number", "type": "string" }, "text": { @@ -388,13 +382,12 @@ "required": [ "text" ] - } + } }, - "table_series": { "type": "array", "title": "Table series", - "description": "Table series", + "description": "Table series", "items": { "type": "object", "properties": { @@ -421,10 +414,9 @@ ] } }, - "statistics": { "type": "array", - "title": "Statistics", + "title": "Statistics", "items": { "type": "object", "properties": { @@ -437,7 +429,7 @@ }, "unit_observation": { "type": "array", - "title": "Unit observation", + "title": "Unit observation", "items": { "type": "object", "properties": { @@ -450,7 +442,7 @@ }, "data_sources": { "type": "array", - "title": "Data sources", + "title": "Data sources", "items": { "type": "object", "properties": { @@ -461,29 +453,27 @@ }, "abbreviation": { "title": "Abbreviation", - "description":"The abbreviation (acronym) of the data source.", + "description": "The abbreviation (acronym) of the data source.", "type": "string" - }, + }, "source_id": { "title": "Source ID", - "description":"A unique identifier for the source, such as a Digital Object Identifier (DOI).", + "description": "A unique identifier for the source, such as a Digital Object Identifier (DOI).", "type": "string" }, "note": { "title": "Note", "type": "string", - "description":"A note that describes how the source was used, possibly mentioning issues in the use of the source." + "description": "A note that describes how the source was used, possibly mentioning issues in the use of the source." }, "uri": { "title": "URI", "type": "string", - "description":"A link (URL) to the source dataset." + "description": "A link (URL) to the source dataset." } } } }, - - "time_periods": { "type": "array", "title": "Time periods", @@ -506,11 +496,10 @@ "from" ] } - }, - + }, "universe": { "type": "array", - "title": "Universe", + "title": "Universe", "items": { "type": "object", "properties": { @@ -521,10 +510,9 @@ } } }, - "ref_country": { "type": "array", - "title": "Reference country", + "title": "Reference country", "items": { "type": "object", "properties": { @@ -539,7 +527,6 @@ } } }, - "geographic_units": { "title": "Geographic locations", "description": "List of geographic units (regions, countries, states, provinces, etc.) for which data are available in the database.", @@ -561,19 +548,43 @@ "title": "Type", "description": "Type of geographic unit e.g. country, state, region, province etc", "type": "string" - } + } }, "required": [ "name" ] } - }, + }, "geographic_granularity": { "description": "Granularity of geographic coverage. examples `national`, `regional`, `provincial`", "type": "string", - "title":"Geographic granularity" + "title": "Geographic granularity" + }, + "bbox": { + "title": "Geographic bounding box", + "type": "array", + "items": { + "type": "object", + "properties": { + "west": { + "title": "West", + "type": "string" + }, + "east": { + "title": "East", + "type": "string" + }, + "south": { + "title": "South", + "type": "string" + }, + "north": { + "title": "North", + "type": "string" + } + } + } }, - "languages": { "type": "array", "description": "languages", @@ -596,10 +607,9 @@ "name" ] }, - "links": { "type": "array", - "title": "Links", + "title": "Links", "items": { "type": "object", "properties": { @@ -614,10 +624,9 @@ } } }, - "publications": { "type": "array", - "title": "Publications", + "title": "Publications", "items": { "type": "object", "properties": { @@ -632,16 +641,18 @@ } } }, - "keywords":{ - "allOf": [ - {"$ref":"#/definitions/keyword"} + "keywords": { + "allOf": [ + { + "$ref": "#/definitions/keyword" + } ], - "title":"Keywords", - "description":"Keywords" + "title": "Keywords", + "description": "Keywords" }, - "themes":{ - "type":"array", - "description":"Themes", + "themes": { + "type": "array", + "description": "Themes", "items": { "type": "object", "properties": { @@ -690,7 +701,7 @@ }, "parent_id": { "title": "Parent topic Identifier", - "description":"For subtopics, provide the ID of the parent topic", + "description": "For subtopics, provide the ID of the parent topic", "type": "string" }, "vocabulary": { @@ -705,11 +716,11 @@ } }, "required": [ - "id","name" + "id", + "name" ] } }, - "disciplines": { "type": "array", "title": "Disciplines", @@ -727,7 +738,7 @@ }, "parent_id": { "title": "Parent discipline Identifier", - "description":"Parent discipline ID", + "description": "Parent discipline ID", "type": "string" }, "vocabulary": { @@ -746,7 +757,6 @@ ] } }, - "definitions": { "type": "array", "title": "Definitions", @@ -774,7 +784,6 @@ ] } }, - "classifications": { "type": "array", "title": "Classifications", @@ -807,16 +816,13 @@ ] } }, - - "rights": { "type": "string", "title": "Rights" }, - "license": { "type": "array", - "title": "License", + "title": "License", "items": { "type": "object", "properties": { @@ -831,24 +837,20 @@ } } }, - "citation": { "type": "string", - "title":"Citation", - "description": "A bibliographic reference for the resource." + "title": "Citation", + "description": "A bibliographic reference for the resource." }, - "confidentiality": { "type": "string", - "title":"Confidentiality" + "title": "Confidentiality" }, - "sdc": { "type": "string", - "title":"Statistical disclosure control", - "description":"Information on statistical disclosure control measures applied to the table. This can include cell suppression, or other techniques. Specialized packages have been developed for this purpose, like [*sdcTable: Methods for Statistical Disclosure Control in Tabular Data*](https://cran.r-project.org/web/packages/sdcTable/index.html) and https://cran.r-project.org/web/packages/sdcTable/sdcTable.pdf \nThe information provided here should be such that it does not provide intruders with useful information for reverse-engineering the protection measures applied to the table." + "title": "Statistical disclosure control", + "description": "Information on statistical disclosure control measures applied to the table. This can include cell suppression, or other techniques. Specialized packages have been developed for this purpose, like [*sdcTable: Methods for Statistical Disclosure Control in Tabular Data*](https://cran.r-project.org/web/packages/sdcTable/index.html) and https://cran.r-project.org/web/packages/sdcTable/sdcTable.pdf \nThe information provided here should be such that it does not provide intruders with useful information for reverse-engineering the protection measures applied to the table." }, - "contacts": { "type": "array", "title": "Contacts", @@ -886,10 +888,9 @@ "name" ] }, - "notes": { "type": "array", - "title": "Notes", + "title": "Notes", "items": { "type": "object", "properties": { @@ -900,7 +901,6 @@ } } }, - "relations": { "type": "array", "title": "Relations", @@ -915,7 +915,7 @@ "type": { "title": "Type", "type": "string", - "enum":[ + "enum": [ "isPartOf", "hasPart", "isVersionOf", @@ -934,19 +934,17 @@ "required": [ "name" ] - } - + } }, "additionalProperties": false }, - - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" + "provenance": { + "type": "array", + "description": "Provenance", + "items": { + "$ref": "provenance-schema.json" } - }, + }, "tags": { "type": "array", "title": "Tags", @@ -968,11 +966,10 @@ "tag" ] }, - "additional": { "type": "object", "description": "Additional metadata", "properties": {} } } -} +} \ No newline at end of file diff --git a/application/schemas/timeseries-db-schema.json b/application/schemas/timeseries-db-schema.json index c9c9116f1..b8e30c18b 100644 --- a/application/schemas/timeseries-db-schema.json +++ b/application/schemas/timeseries-db-schema.json @@ -5,21 +5,21 @@ "description": "Schema for timeseries database", "type": "object", "properties": { - "published": { "type": "integer", "title": "Status", "description": "0=draft, 1=published", "default": 0 }, - "overwrite": { "type": "string", "description": "Overwrite database if already exists?", - "enum": ["yes", "no"], + "enum": [ + "yes", + "no" + ], "default": "no" }, - "metadata_information": { "type": "object", "title": "Document metadata information", @@ -79,16 +79,36 @@ "title": "Database Description", "description": "Database Description", "properties": { - "title_statement": { "type": "object", "description": "Study title", - "properties": { "idno": { "type": "string", "title": "Unique user defined ID", - "description": "The ID number of a dataset is a unique number that is used to identify a particular survey. Define and use a consistent scheme to use. Such an ID could be constructed as follows: country-producer-survey-year-version where \n - country is the 3-letter ISO country abbreviation \n - producer is the abbreviation of the producing agency \n - survey is the survey abbreviation \n - year is the reference year (or the year the survey started) \n - version is the number dataset version number (see Version Description below)" + "description": "The ID number of a database is a unique number that is used to identify a particular database." + }, + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" + }, + "identifier": { + "title": "Identifier", + "type": "string" + } + }, + "required": [ + "identifier" + ] + } }, "title": { "type": "string", @@ -99,13 +119,11 @@ "type": "string", "title": "Survey subtitle", "description": "A short subtitle for the survey" - }, "alternate_title": { "type": "string", "title": "Abbreviation or Acronym", "description": "The abbreviation of a survey is usually the first letter of each word of the titled survey. The survey reference year(s) may be included." - }, "translated_title": { "title": "Translated Title", @@ -118,7 +136,6 @@ "title" ] }, - "authoring_entity": { "type": "array", "title": "Authoring entity", @@ -130,12 +147,7 @@ "title": "Agency Name", "type": "string", "description": "Name of the person, corporate body, or agency responsible for the work's substantive and intellectual content. If a person, invert first and last name and use commas." - }, - "role": { - "title": "Role", - "type": "string", - "description": "Title of the person (if any) responsible for the work's substantive and intellectual content." - }, + }, "affiliation": { "title": "Affiliation", "type": "string" @@ -147,6 +159,10 @@ "email": { "title": "Email", "description": "Email" + }, + "uri": { + "title": "URI", + "type": "string" } }, "required": [ @@ -210,7 +226,8 @@ } }, "required": [ - "version", "date" + "version", + "date" ] } }, @@ -331,7 +348,8 @@ } }, "required": [ - "id", "name" + "id", + "name" ] } }, @@ -418,18 +436,15 @@ } } }, - "geographic_granularity": { "title": "Geographic granularity", "description": "Granularity of geographic coverage e.g. `national`, `regional`, `provincial`", "type": "string" }, - "geographic_area_count": { "description": "Number of geographic areas", "type": "string" }, - "sponsors": { "type": "array", "title": "Sponsor/Funding Agency", @@ -467,7 +482,6 @@ "name" ] }, - "acknowledgments": { "type": "array", "title": "Other Acknowledgments", @@ -497,12 +511,10 @@ "name" ] }, - "acknowledgement_statement": { "title": "An overall statement of acknowledgment, which can be used as an alternative (or supplement) to the itemized list provided in `acknowledgments`.", "type": "string" }, - "contacts": { "type": "array", "title": "Contacts", @@ -540,7 +552,6 @@ "name" ] }, - "links": { "type": "array", "title": "Related links", @@ -562,7 +573,6 @@ "uri" ] }, - "languages": { "type": "array", "description": "Supported languages", @@ -655,7 +665,6 @@ } } }, - "disclaimer": { "title": "Disclaimer", "type": "string" @@ -670,7 +679,6 @@ ], "additionalProperties": false }, - "additional": { "type": "object", "title": "Additional custom metadata", diff --git a/application/schemas/timeseries-schema.json b/application/schemas/timeseries-schema.json index 763a9d330..2a7e2cf30 100644 --- a/application/schemas/timeseries-schema.json +++ b/application/schemas/timeseries-schema.json @@ -5,897 +5,972 @@ "description": "Schema for timeseries data type", "type": "object", "properties": { - - "repositoryid": { - "type": "string", - "title": "Collection ID that owns the series", - "description": "Collection that owns the series" - }, - - "access_policy": { - "type": "string", - "title": "Data access policy", - "description": "Data access policy for attached microdata resources", - "enum": [ - "direct", - "open", - "public", - "licensed", - "remote", - "na" - ], - "default": "na" - }, - - "data_remote_url": { - "type": "string", - "title": "Data website URL", - "description": "Link to the website where the data is available, this is only needed if `access_policy` is set to `remote`." - }, - "published": { - "type": "integer", - "title": "Status", - "description": "Status of the study - 0=draft, 1=published", - "default": 0 - }, - "overwrite": { - "type": "string", - "description": "Overwrite database if already exists?", - "enum":["yes","no"], - "default": "no" - }, - - "metadata_creation": { - "type": "object", - "title": "Metadata creation", - "description": "Information on who generated the documentation", - "properties": { - - "producers": { - "type": "array", - "title": "Producers", - "description": "List of producers", - "items": { - "type": "object", - "properties": { - "name": { - "title": "Name", - "description": "Name (required)", - "type": "string" - }, - "abbr": { - "title": "Abbreviation", - "type": "string" + "repositoryid": { + "type": "string", + "title": "Collection ID that owns the series", + "description": "Collection that owns the series" + }, + "access_policy": { + "type": "string", + "title": "Data access policy", + "description": "Data access policy for attached microdata resources", + "enum": [ + "direct", + "open", + "public", + "licensed", + "remote", + "na" + ], + "default": "na" + }, + "data_remote_url": { + "type": "string", + "title": "Data website URL", + "description": "Link to the website where the data is available, this is only needed if `access_policy` is set to `remote`." + }, + "published": { + "type": "integer", + "title": "Status", + "description": "Status of the study - 0=draft, 1=published", + "default": 0 + }, + "overwrite": { + "type": "string", + "description": "Overwrite database if already exists?", + "enum": [ + "yes", + "no" + ], + "default": "no" + }, + "metadata_creation": { + "type": "object", + "title": "Metadata creation", + "description": "Information on who generated the documentation", + "properties": { + "producers": { + "type": "array", + "title": "Producers", + "description": "List of producers", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Name (required)", + "type": "string" + }, + "abbr": { + "title": "Abbreviation", + "type": "string" + }, + "affiliation": { + "type": "string", + "title": "Affiliation" + }, + "role": { + "title": "Role", + "type": "string" + } + } + }, + "required": [ + "name" + ] }, - "affiliation": { - "type": "string", - "title": "Affiliation" + "prod_date": { + "title": "Date of Production", + "description": "Document production date using format(YYYY-MM-DD)", + "type": "string" }, - "role": { - "title": "Role", - "type": "string" + "version": { + "title": "Document version", + "description": "Identify and describe the current version of the document", + "type": "string" } - } }, - "required": [ - "name" - ] - }, - "prod_date": { - "title": "Date of Production", - "description": "Document production date using format(YYYY-MM-DD)", - "type": "string" - }, - "version": { - "title": "Document version", - "description": "Identify and describe the current version of the document", - "type": "string" - } + "additionalProperties": false }, - "additionalProperties": false - }, - - "series_description":{ - "description" :"Series information", - "type": "object", - "properties": { - "idno": { - "type": "string", - "title": "Series unique ID", - "description": "Unique series ID" - }, - "name": { - "type": "string", - "title": "Series Name" - }, - "database_id": { - "type": "string", - "title": "Database ID", - "description": "Series database ID" - }, - "aliases": { - "type": "array", - "title": "Series other names", - "items": { - "type": "object", - "properties": { - "alias": { - "title": "Alias", - "type": "string" - } - } - } - }, - "alternate_identifiers": { - "type": "array", - "title": "Alternate identifiers", - "items": { - "type": "object", - "properties": { - "identifier": { - "title": "Identifier", - "type": "string" - }, - "name": { - "title": "Identifier name", - "type": "string" - }, - "database": { - "title": "Database", - "type": "string" - }, - "uri": { - "title": "URI", - "type": "string" - }, - "notes": { - "title": "Notes", - "type": "string" - } - }, - "required": [ - "identifier" - ] - } - }, - "measurement_unit": { - "type": "string", - "title": "Series unit of measure" - }, - "periodicity": { - "type": "string", - "title": "Periodicity of data" - }, - "base_period": { - "type": "string", - "title": "Base period" - }, - "definition_short": { - "type": "string", - "title": "Definition short" - }, - "definition_long": { - "type": "string", - "title": "Definition long" - }, - "definition_references": { - "type": "array", - "title": "Definition references", - "description": "URL to standard definition of the indicator (international or national standard)", - "items": { - "type": "object", - "properties": { - "source": { - "title": "Source", - "type": "string" - }, - "uri": { - "title": "URI", - "description": "URI", - "type": "string" - }, - "note": { - "title": "Note", - "description": "Note", - "type": "string" - } - }, - "required": [ - "uri" - ] - } - }, - - "statistical_concept": { - "type": "string", - "title": "Statistical concept" - }, - - "concepts": { - "type": "array", - "title": "Related concepts", - "description": "Related concepts", - "items": { - "type": "object", - "properties": { - "name": { - "title": "Name", - "type": "string" - }, - "definition": { - "title": "Definition", - "description": "Definition", - "type": "string" - }, - "uri": { - "title": "URI", - "description": "Website link", - "type": "string" - } - }, - "required": [ - "name" - ] - } - }, - "methodology": { - "type": "string", - "title": "Methodology" - }, - "imputation": { - "type": "string", - "title": "Imputations" - }, - "missing": { - "type": "string", - "title": "Treatment of missing values" - }, - "quality_checks": { - "type": "string", - "title": "Quality control methods" - }, - "quality_note": { - "type": "string", - "title": "Note on data quality" - }, - "sources_discrepancies": { - "type": "string", - "title": "Discrepency sources" - }, - "series_break": { - "type": "string", - "title": "Breaks in series" - }, - - "limitation": { - "type": "string", - "title": "Limitations and exceptions" - }, - - "themes":{ - "type":"array", - "title":"Themes", - "items":{ - "type":"object", - "properties":{ - "name":{ - "title":"Name", - "type":"string" - }, - "vocabulary":{ - "title":"Vocabulary name", - "type":"string" - }, - "uri":{ - "title":"Vocabulary URI", - "type":"string" - } - } - } - }, - "topics": { - "type": "array", - "title": "Topics", - "description": "Topics covered by the table (ideally, the list of topics will be a controlled vocabulary)", - "items": { - "type": "object", - "properties": { - "id": { - "title": "Unique Identifier", - "type": "string" + "series_description": { + "description": "Series information", + "type": "object", + "properties": { + "idno": { + "type": "string", + "title": "Series unique ID", + "description": "Unique series ID" }, "name": { - "title": "Topic", - "type": "string" - }, - "parent_id": { - "title": "Parent topic Identifier", - "description":"For subtopics, provide the ID of the parent topic", - "type": "string" - }, - "vocabulary": { - "title": "Vocabulary", - "description": "Name of the controlled vocabulary, if the topic is from a taxonomy.", - "type": "string" - }, - "uri": { - "title": "Vocabulary URI", - "description": "Link to the controlled vocabulary web page, if the topic is from a taxonomy.", - "type": "string" - } - }, - "required": [ - "name" - ] - } - }, - - "disciplines": { - "type": "array", - "title": "Disciplines", - "description": "Disciplines e.g. `Social sciences, economics`, `Natural sciences, biology`", - "items": { - "type": "object", - "properties": { - "name": { - "title": "Discipline title or name", - "type": "string" - }, - "vocabulary": { - "title": "Vocabulary", - "description": "Vocabulary", - "type": "string" - }, - "uri": { - "title": "URI", - "description": "Website link", - "type": "string" - } - }, - "required": [ - "name" - ] - } - }, - - - "relevance": { - "type": "string", - "title": "Relavance" - }, - "time_periods": { - "type": "array", - "title": "Series dates", - "items": { - "type": "object", - "properties": { - "start": { - "type": "string", - "title": "Start" - }, - "end": { - "type": "string", - "title": "End" - } - } - } - }, - "geographic_units": { - "title": "Geographic locations", - "description": "List of geographic units (regions, countries, states, provinces, etc.) for which data are available in the database.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "title": "Location name", - "description": "Name of the geographic unit e.g. 'World', 'Africa', 'Afghanistan'", - "type": "string" - }, - "code": { - "title": "Location code", - "description": "Code of the geographic unit (for countries, preferred = ISO3 code)", - "type": "string" - }, - "type": { - "title": "Type", - "description": "Type of geographic unit e.g. country, state, region, province etc", - "type": "string" - } - }, - "required": [ - "name" - ] - } - }, - "aggregation_method": { - "type": "string", - "title": "Aggregation method" - }, - "disaggregation": { - "type": "string", - "title": "Dissaggregation" - }, - "license": { - "type": "object", - "title": "Access licence", - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "uri": { - "type": "string", - "title": "URI" - } - } - }, - "confidentiality": { - "type": "string", - "title": "Confidentiality statement", - "description": "Confidentiality statement" - }, - "confidentiality_status": { - "type": "string", - "title": "Confidentiality status" - }, - "confidentiality_note": { - "type": "string", - "title": "Confidentiality note" - }, - "links": { - "type": "array", - "title": "Series links", - "description": "Links to API calls, websites, etc.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "title": "Link type", - "description": "Link types - API, website, etc." - }, - "description": { - "type": "string", - "title": "Description" - }, - "uri": { - "type": "string", - "title": "URI" - } - } - } - }, - "api_documentation": { - "type": "object", - "description": "API Documentation", - "properties": { - "description": { - "title": "Description", - "type": "string" - }, - "uri": { - "title": "URI", - "type": "string" - } - } - }, - "sources":{ - "type":"array", - "title":"Sources", - "description":"Sources", - "items": { + "type": "string", + "title": "Series Name" + }, + "database_id": { + "type": "string", + "title": "Database ID", + "description": "Series database ID" + }, + "aliases": { + "type": "array", + "title": "Series other names", + "items": { "type": "object", "properties": { - "id": { - "title": "Source ID", - "type": "string" - }, - "name": { - "title": "Name", - "description": "Source name", + "alias": { + "title": "Alias", + "type": "string" + } + } + } + }, + "alternate_identifiers": { + "type": "array", + "title": "Alternate identifiers", + "items": { + "type": "object", + "properties": { + "identifier": { + "title": "Identifier", + "type": "string" + }, + "name": { + "title": "Identifier name", + "type": "string" + }, + "database": { + "title": "Database", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + }, + "notes": { + "title": "Notes", + "type": "string" + } + }, + "required": [ + "identifier" + ] + } + }, + "measurement_unit": { + "type": "string", + "title": "Series unit of measure" + }, + "dimensions": { + "type": "array", + "title": "Dimensions", + "items": { + "type": "object", + "properties": { + "label": { + "title": "Label", + "type": "string" + }, + "description": { + "title": "Description", + "type": "string" + } + }, + "required": [ + "label" + ] + } + }, + "periodicity": { + "type": "string", + "title": "Periodicity of data" + }, + "base_period": { + "type": "string", + "title": "Base period" + }, + "definition_short": { + "type": "string", + "title": "Definition short" + }, + "definition_long": { + "type": "string", + "title": "Definition long" + }, + "definition_references": { + "type": "array", + "title": "Definition references", + "description": "URL to standard definition of the indicator (international or national standard)", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "uri": { + "title": "URI", + "description": "URI", + "type": "string" + }, + "note": { + "title": "Note", + "description": "Note", + "type": "string" + } + }, + "required": [ + "uri" + ] + } + }, + "statistical_concept": { + "type": "string", + "title": "Statistical concept" + }, + "concepts": { + "type": "array", + "title": "Related concepts", + "description": "Related concepts", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "definition": { + "title": "Definition", + "description": "Definition", + "type": "string" + }, + "uri": { + "title": "URI", + "description": "Website link", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + "methodology": { + "type": "string", + "title": "Methodology" + }, + "imputation": { + "type": "string", + "title": "Imputations" + }, + "missing": { + "type": "string", + "title": "Treatment of missing values" + }, + "quality_checks": { + "type": "string", + "title": "Quality control methods" + }, + "quality_note": { + "type": "string", + "title": "Note on data quality" + }, + "sources_discrepancies": { + "type": "string", + "title": "Discrepency sources" + }, + "series_break": { + "type": "string", + "title": "Breaks in series" + }, + "limitation": { + "type": "string", + "title": "Limitations and exceptions" + }, + "themes": { + "type": "array", + "title": "Themes", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary name", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "type": "string" + } + } + } + }, + "topics": { + "type": "array", + "title": "Topics", + "description": "Topics covered by the table (ideally, the list of topics will be a controlled vocabulary)", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, + "name": { + "title": "Topic", + "type": "string" + }, + "parent_id": { + "title": "Parent topic Identifier", + "description": "For subtopics, provide the ID of the parent topic", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Name of the controlled vocabulary, if the topic is from a taxonomy.", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the topic is from a taxonomy.", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + "disciplines": { + "type": "array", + "title": "Disciplines", + "description": "Disciplines e.g. `Social sciences, economics`, `Natural sciences, biology`", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Discipline title or name", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Vocabulary", + "type": "string" + }, + "uri": { + "title": "URI", + "description": "Website link", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + "relevance": { + "type": "string", + "title": "Relavance" + }, + "time_periods": { + "type": "array", + "title": "Series dates", + "items": { + "type": "object", + "properties": { + "start": { + "type": "string", + "title": "Start" + }, + "end": { + "type": "string", + "title": "End" + } + } + } + }, + "geographic_units": { + "title": "Geographic locations", + "description": "List of geographic units (regions, countries, states, provinces, etc.) for which data are available in the database.", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Location name", + "description": "Name of the geographic unit e.g. 'World', 'Africa', 'Afghanistan'", + "type": "string" + }, + "code": { + "title": "Location code", + "description": "Code of the geographic unit (for countries, preferred = ISO3 code)", + "type": "string" + }, + "type": { + "title": "Type", + "description": "Type of geographic unit e.g. country, state, region, province etc", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + "bbox": { + "title": "Geographic bounding box", + "type": "array", + "items": { + "type": "object", + "properties": { + "west": { + "title": "West", + "type": "string" + }, + "east": { + "title": "East", + "type": "string" + }, + "south": { + "title": "South", + "type": "string" + }, + "north": { + "title": "North", + "type": "string" + } + } + } + }, + "aggregation_method": { + "type": "string", + "title": "Aggregation method" + }, + "disaggregation": { + "type": "string", + "title": "Dissaggregation" + }, + "license": { + "type": "object", + "title": "Access licence", + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "uri": { + "type": "string", + "title": "URI" + } + } + }, + "confidentiality": { + "type": "string", + "title": "Confidentiality statement", + "description": "Confidentiality statement" + }, + "confidentiality_status": { + "type": "string", + "title": "Confidentiality status" + }, + "confidentiality_note": { + "type": "string", + "title": "Confidentiality note" + }, + "links": { + "type": "array", + "title": "Series links", + "description": "Links to API calls, websites, etc.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "title": "Link type", + "description": "Link types - API, website, etc." + }, + "description": { + "type": "string", + "title": "Description" + }, + "uri": { + "type": "string", + "title": "URI" + } + } + } + }, + "api_documentation": { + "type": "object", + "description": "API Documentation", + "properties": { + "description": { + "title": "Description", "type": "string" - }, - "organization": { - "title": "Organization", + }, + "uri": { + "title": "URI", "type": "string" - }, - "type": { - "title": "Source type", - "type": "string" - }, - "note": { - "title": "Note", - "type": "string" - } + } + } + }, + "authoring_entity": { + "type": "array", + "title": "Authoring entity", + "description": "The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Agency Name", + "type": "string", + "description": "Name of the person, corporate body, or agency responsible for the work's substantive and intellectual content. If a person, invert first and last name and use commas." + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "abbreviation": { + "title": "Abbreviation", + "description": "Abbreviation" + }, + "email": { + "title": "Email", + "description": "Email" + }, + "uri": { + "title": "URI", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + "sources": { + "type": "array", + "title": "Sources", + "description": "Sources", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Source ID", + "type": "string" + }, + "name": { + "title": "Name", + "description": "Source name", + "type": "string" + }, + "organization": { + "title": "Organization", + "type": "string" + }, + "type": { + "title": "Source type", + "type": "string" + }, + "note": { + "title": "Note", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + "sources_note": { + "type": "string", + "title": "Notes form original sources" + }, + "keywords": { + "type": "array", + "description": "Keywords", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Keyword", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } }, "required": [ - "name" + "name" ] - } + } + }, + "acronyms": { + "type": "array", + "description": "Acronyms", + "items": { + "type": "object", + "properties": { + "acronym": { + "title": "Acronym or abbreviation", + "type": "string" + }, + "expansion": { + "title": "Expansion of the acronym or abbreviation", + "type": "string" + }, + "occurrence": { + "title": "Occurrence of the acronym in the document", + "type": "number" + } + }, + "required": [ + "acronym", + "expansion" + ] + } + }, + "notes": { + "title": "Notes", + "description": "Notes", + "type": "array", + "items": { + "type": "object", + "properties": { + "note": { + "title": "Note", + "type": "string" + } + } + } + }, + "related_indicators": { + "type": "array", + "description": "Related indicators", + "items": { + "type": "object", + "properties": { + "code": { + "title": "Indicator code", + "type": "string" + }, + "label": { + "title": "Indicator name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } }, - - "sources_note": { - "type": "string", - "title": "Notes form original sources" - }, - "keywords": { - "type": "array", - "description": "Keywords", - "items": { - "type": "object", - "properties": { - "name": { - "title": "Keyword", - "type": "string" - }, - "vocabulary": { - "title": "Vocabulary", - "type": "string" - }, - "uri": { - "title": "URI", - "type": "string" - } - }, - "required": [ - "name" - ] - } - }, - "acronyms": { - "type": "array", - "description": "Acronyms", - "items": { - "type": "object", - "properties": { - "acronym": { - "title": "Acronym or abbreviation", - "type": "string" - }, - "expansion": { - "title": "Expansion of the acronym or abbreviation", - "type": "string" - }, - "occurrence": { - "title": "Occurrence of the acronym in the document", - "type": "number" - } - }, - "required": [ - "acronym", "expansion" - ] - } - }, - "notes": { - "title": "Notes", - "description": "Notes", - "type": "array", - "items": { - "type": "object", - "properties": { - "note": { - "title": "Note", - "type": "string" - } - } - } - }, - "related_indicators": { - "type": "array", - "description": "Related indicators", - "items": { - "type": "object", - "properties": { - "code": { - "title": "Indicator code", - "type": "string" - }, - "label": { - "title": "Indicator name", - "type": "string" - }, - "uri": { - "title": "URI", - "type": "string" - } - } - }, - "required": [ - "code" - ] - }, - "compliance": { - "type": "array", - "title": "Compliance with international resolution", - "description": "Compliance with international resolution", - "items": { - "type": "object", - "properties": { - "standard": { - "type": "string", - "title": "Standard name" - }, - "organization": { - "type": "string", - "title": "Organization name" - }, - "uri": { - "type": "string", - "title": "URI" - } - }, - "required": [ - "standard" - ] - } - }, - "framework": { - "type": "array", - "title": "Framework", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "description": { - "type": "string", - "title": "Description" - }, - "goal_id": { - "type": "string", - "title": "Goal ID" - }, - "goal_name": { - "type": "string", - "title": "Goal name" - }, - "goal_description": { - "type": "string", - "title": "Goal description" - }, - "target_id": { - "type": "string", - "title": "target ID" - }, - "target_name": { - "type": "string", - "title": "Target name" - }, - "target_description": { - "type": "string", - "title": "Target description" - }, - "indicator_id": { - "type": "string", - "title": "Indicator ID" - }, - "indicator_name": { - "type": "string", - "title": "Indicator name" - }, - "indicator_description": { - "type": "string", - "title": "Indicator description" - }, - "uri": { - "type": "string", - "title": "URI" - }, - "notes": { - "type": "string", - "title": "Description" - } - }, - "required": [ - "name" - ] - } - }, - "lda_topics": { - "type": "array", - "title": "LDA topics", - "description": "LDA topics", - "items": { + "required": [ + "code" + ] + }, + "compliance": { + "type": "array", + "title": "Compliance with international resolution", + "description": "Compliance with international resolution", + "items": { "type": "object", "properties": { - "model_info": { - "type": "array", - "title": "Model information", - "items": { - "type": "object", - "properties": { - "source": { - "title": "Source", - "type": "string" - }, - "author": { - "title": "Author", - "type": "string" - }, - "version": { - "title": "Version", - "type": "string" - }, - "model_id": { - "title": "Model Identifier", - "type": "string" - }, - "nb_topics": { - "title": "Number of topics", - "type": "number" - }, - "description": { - "title": "Description", - "type": "string" - }, - "corpus": { - "title": "Corpus name", - "type": "string" - }, - "uri": { - "title": "URI", - "type": "string" - } - } - }, - "required": [ - "model_id" - ] - }, - "topic_description": { - "type": "array", - "title": "Topic information", - "items": { - "type": "object", - "properties": { - "topic_id": { - "title": "Topic identifier", - "type": ["integer", "string"] - }, - "topic_score": { - "title": "Topic score", - "type": ["number", "string"] - }, - "topic_label": { - "title": "Topic label", - "type": "string" + "standard": { + "type": "string", + "title": "Standard name" + }, + "organization": { + "type": "string", + "title": "Organization name" + }, + "uri": { + "type": "string", + "title": "URI" + } + }, + "required": [ + "standard" + ] + } + }, + "framework": { + "type": "array", + "title": "Framework", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "description": { + "type": "string", + "title": "Description" + }, + "goal_id": { + "type": "string", + "title": "Goal ID" + }, + "goal_name": { + "type": "string", + "title": "Goal name" + }, + "goal_description": { + "type": "string", + "title": "Goal description" + }, + "target_id": { + "type": "string", + "title": "target ID" + }, + "target_name": { + "type": "string", + "title": "Target name" + }, + "target_description": { + "type": "string", + "title": "Target description" + }, + "indicator_id": { + "type": "string", + "title": "Indicator ID" + }, + "indicator_name": { + "type": "string", + "title": "Indicator name" + }, + "indicator_description": { + "type": "string", + "title": "Indicator description" + }, + "uri": { + "type": "string", + "title": "URI" + }, + "notes": { + "type": "string", + "title": "Description" + } + }, + "required": [ + "name" + ] + } + }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } }, - "topic_words": { - "type": "array", - "title": "Topic words", - "description": "Words", - "items": { + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { "type": "object", "properties": { - "word": { - "title": "Word", - "type": "string" - }, - "word_weight": { - "title": "Word weight", - "type": "number" - } + "topic_id": { + "title": "Topic identifier", + "type": [ + "integer", + "string" + ] + }, + "topic_score": { + "title": "Topic score", + "type": [ + "number", + "string" + ] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } } - }, - "required": [ - "word" - ] - } - } - }, - "required": [ - "topic_id" - ] - } + }, + "required": [ + "topic_id" + ] + } }, "additionalProperties": false - } + } + }, + "embeddings": { + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + } }, - "embeddings":{ - "type": "array", - "title": "Word embeddings", - "description": "Word embeddings", - "items": { + "required": [ + "id", + "vector" + ] + }, + "series_groups": { + "type": "array", + "title": "Series groups", + "description": "Series included in groups", + "items": { "type": "object", "properties": { - "id": { - "title": "Vector Model ID", - "type": "string" - }, - "description": { - "title": "Vector Model Description", - "type": "string" - }, - "date": { - "title": "Date (YYYY-MM-DD)", - "type": "string" - }, - "vector": { - "title": "Vector", - "type": "object" - } + "name": { + "type": "string", + "title": "Name" + }, + "description": { + "type": "string", + "title": "Description", + "description": "A brief description of the series group." + }, + "version": { + "type": "string", + "title": "Version" + }, + "uri": { + "type": "string", + "title": "URI" + } } - }, - "required": [ - "id","vector" - ] }, - "series_groups": { - "type": "array", - "title": "Series groups", - "description": "Series included in groups", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "description": { - "type": "string", - "title": "Description", - "description":"A brief description of the series group." - }, - "version": { - "type": "string", - "title": "Version" - }, - "uri": { - "type": "string", - "title": "URI" - } - } - }, - "required": [ - "name" - ] - } - }, - "required": [ - "idno", - "name" - ] - + "required": [ + "name" + ] + } + }, + "required": [ + "idno", + "name" + ] }, - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" - } + "provenance": { + "type": "array", + "description": "Provenance", + "items": { + "$ref": "provenance-schema.json" + } }, "tags": { - "type": "array", - "title": "Tags (user-defined)", - "description": "Tags", - "items": { - "type": "object", - "properties": { - "tag": { - "title": "Tag", - "type": "string" - }, - "tag_group": { - "title": "Tag group", - "type": "string" - } - } - }, - "required": [ - "tag" - ] + "type": "array", + "title": "Tags (user-defined)", + "description": "Tags", + "items": { + "type": "object", + "properties": { + "tag": { + "title": "Tag", + "type": "string" + }, + "tag_group": { + "title": "Tag group", + "type": "string" + } + } + }, + "required": [ + "tag" + ] }, "additional": { - "type": "object", - "title":"Additional custom metadata", - "description": "Any other custom metadata not covered by the schema", - "properties": {} + "type": "object", + "title": "Additional custom metadata", + "description": "Any other custom metadata not covered by the schema", + "properties": {} } - }, - "required": [ + }, + "required": [ "series_description" - ] - } \ No newline at end of file + ] +} \ No newline at end of file diff --git a/application/schemas/video-schema.json b/application/schemas/video-schema.json index 6690084f7..9a979015e 100644 --- a/application/schemas/video-schema.json +++ b/application/schemas/video-schema.json @@ -87,7 +87,29 @@ "idno": { "type": "string", "title": "Unique video identifier" - }, + }, + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" + }, + "identifier": { + "title": "Identifier", + "type": "string" + } + }, + "required": [ + "identifier" + ] + } + }, "title": { "type": "string", "description": "Title" From 33afa576ef49e2af8253555ab180efca14c173ba Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Thu, 10 Mar 2022 09:46:34 -0500 Subject: [PATCH 13/79] misc updates for schemas --- .../catalog-admin/document-schema.json | 295 +++++----- .../catalog-admin/geospatial-schema.json | 132 ++++- .../catalog-admin/image-schema.json | 174 +++++- .../catalog-admin/script-schema.json | 254 ++++++-- .../catalog-admin/survey-schema.json | 231 ++++++-- .../catalog-admin/table-schema.json | 134 +++++ .../catalog-admin/timeseries-db-schema.json | 69 ++- .../catalog-admin/timeseries-schema.json | 253 +++++++- .../catalog-admin/variable-schema.json | 149 ++--- .../catalog-admin/video-schema.json | 171 +++++- .../catalog-admin/visualization-schema.json | 188 +++++- application/schemas/document-schema.json | 295 +++++----- application/schemas/geospatial-schema.json | 132 ++++- application/schemas/image-schema.json | 174 +++++- application/schemas/script-schema.json | 386 +++++++++--- application/schemas/survey-schema.json | 231 ++++++-- application/schemas/table-schema.json | 134 +++++ application/schemas/timeseries-db-schema.json | 69 ++- application/schemas/timeseries-schema.json | 253 +++++++- application/schemas/variable-schema.json | 149 ++--- application/schemas/video-schema.json | 553 +++++++++++++++--- application/schemas/visualization-schema.json | 188 +++++- 22 files changed, 3681 insertions(+), 933 deletions(-) diff --git a/api-documentation/catalog-admin/document-schema.json b/api-documentation/catalog-admin/document-schema.json index b85794a16..311756b1b 100644 --- a/api-documentation/catalog-admin/document-schema.json +++ b/api-documentation/catalog-admin/document-schema.json @@ -130,12 +130,10 @@ }, "alternate_title": { "type": "string", - "title": "Abbreviation or Acronym", - "description": "Any form of the title used as a substitute or alternative to the formal title of the resource." + "title": "Abbreviation or Acronym" }, - "abbreviated_title": { - "title": "Abbreviated Title", - "description": "Title as abbreviated for indexing or identification.", + "translated_title": { + "title": "Translated Title", "type": "string" } }, @@ -185,6 +183,11 @@ } } } + }, + "full_name": { + "title": "Full name", + "type": "string", + "description": "Full name of the author. This element to be used only when first or last name cannot be distinguished." } } }, @@ -586,7 +589,7 @@ }, "url": { - "type": "string", + "type": ["string", "array"], "title": "URL", "description":"URL of the document, preferably a permanent URL" }, @@ -733,30 +736,29 @@ }, "sources": { - "type": "object", + "type":"array", "title": "Sources", - "description": "Description of sources used. The element is nestable so that the sources statement might encompass a series of discrete source statements, each of which could contain the facts about an individual source. ", - "_ddi_xpath":"stdyDscr/method/dataColl/sources", + "description": "Description of sources used. The element is nestable so that the sources statement might encompass a series of discrete source statements, each of which could contain the facts about an individual source. ", + "items":{ + "type": "object", "properties": { "source_origin":{ "type":"string", "title":"Origin of Source", - "description":"For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcOrig" + "description":"For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. " }, "source_char":{ "type":"string", "title":"Characteristics of Source Noted", - "description":"Assessment of characteristics and quality of source material. May not be relevant to survey data.", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcChar" + "description":"Assessment of characteristics and quality of source material. May not be relevant to survey data." }, "source_doc":{ "type":"string", "title":"Source documentation", - "description":"Documentation and Access to Sources", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcDocu" + "description":"Documentation and Access to Sources" } } + } }, "data_sources":{ @@ -982,138 +984,7 @@ } } } - }, - - "lda_topics": { - "type": "array", - "title": "LDA topics", - "description": "LDA topics", - "items": { - "type": "object", - "properties": { - "model_info": { - "type": "array", - "title": "Model information", - "items": { - "type": "object", - "properties": { - "source": { - "title": "Source", - "type": "string" - }, - "author": { - "title": "Author", - "type": "string" - }, - "version": { - "title": "Version", - "type": "string" - }, - "model_id": { - "title": "Model Identifier", - "type": "string" - }, - "nb_topics": { - "title": "Number of topics", - "type": "number" - }, - "description": { - "title": "Description", - "type": "string" - }, - "corpus": { - "title": "Corpus name", - "type": "string" - }, - "uri": { - "title": "URI", - "type": "string" - } - } - }, - "required": [ - "model_id" - ] - }, - "topic_description": { - "type": "array", - "title": "Topic information", - "items": { - "type": "object", - "properties": { - "topic_id": { - "title": "Topic identifier", - "type": ["integer", "string"] - }, - "topic_score": { - "title": "Topic score", - "type": ["number", "string"] - }, - "topic_label": { - "title": "Topic label", - "type": "string" - }, - "topic_words": { - "type": "array", - "title": "Topic words", - "description": "Words", - "items": { - "type": "object", - "properties": { - "word": { - "title": "Word", - "type": "string" - }, - "word_weight": { - "title": "Word weight", - "type": "number" - } - } - }, - "required": [ - "word" - ] - } - } - }, - "required": [ - "topic_id" - ] - } - - }, - "additionalProperties": false - } - }, - "embeddings":{ - "type": "array", - "title": "Word embeddings", - "description": "Word embeddings", - "items": { - "type": "object", - "properties": { - "id": { - "title": "Vector Model ID", - "type": "string" - }, - "description": { - "title": "Vector Model Description", - "type": "string" - }, - "date": { - "title": "Date (YYYY-MM-DD)", - "type": "string" - }, - "vector": { - "title": "Vector", - "type": "object" - } - }, - "required": [ - "id","vector" - ] - } - } + } }, "required":["title_statement"], "additionalProperties": false @@ -1146,6 +1017,136 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata", diff --git a/api-documentation/catalog-admin/geospatial-schema.json b/api-documentation/catalog-admin/geospatial-schema.json index 67d68df1a..ef94c08d5 100644 --- a/api-documentation/catalog-admin/geospatial-schema.json +++ b/api-documentation/catalog-admin/geospatial-schema.json @@ -2027,7 +2027,137 @@ "required": [ "tag" ] - }, + }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "title": "Additional metadata", "description": "Any additional metadata", diff --git a/api-documentation/catalog-admin/image-schema.json b/api-documentation/catalog-admin/image-schema.json index de8188bf2..01be446d4 100644 --- a/api-documentation/catalog-admin/image-schema.json +++ b/api-documentation/catalog-admin/image-schema.json @@ -165,28 +165,7 @@ } } } - }, - "tags": { - "type": "array", - "title": "Tags", - "description": "Tags", - "items": { - "type": "object", - "properties": { - "tag": { - "title": "Tag", - "type": "string" - }, - "tag_group": { - "title": "Tag group", - "type": "string" - } - } - }, - "required": [ - "tag" - ] - } + } } }, "provenance":{ @@ -196,6 +175,157 @@ "$ref":"provenance-schema.json" } }, + "tags": { + "type": "array", + "title": "Tags", + "description": "Tags", + "items": { + "type": "object", + "properties": { + "tag": { + "title": "Tag", + "type": "string" + }, + "tag_group": { + "title": "Tag group", + "type": "string" + } + } + }, + "required": [ + "tag" + ] + }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata", diff --git a/api-documentation/catalog-admin/script-schema.json b/api-documentation/catalog-admin/script-schema.json index b73cac6cf..d2dbfc4c1 100644 --- a/api-documentation/catalog-admin/script-schema.json +++ b/api-documentation/catalog-admin/script-schema.json @@ -369,10 +369,12 @@ }, "abbreviation": { "title": "Abbreviation", - "description": "Abbreviation" + "description": "Abbreviation", + "type": "string" }, "email": { "title": "Email", + "type": "string", "description": "Email" }, "author_id": { @@ -384,10 +386,12 @@ "properties": { "type": { "title": "Type", + "type": "string", "description": "Source of identifier, e.g. ORCID" }, "id": { "title": "Identifier", + "type": "string", "description": "Author's unique identifier for the corresponding source" } } @@ -407,7 +411,7 @@ "type": "object", "properties": { "name": { - "title": "N`ame", + "title": "Name", "type": "string", "description": "Name of the person, corporate body, or agency responsible for the work's substantive and intellectual content. If a person, invert first and last name and use commas." }, @@ -422,14 +426,17 @@ }, "abbreviation": { "title": "Abbreviation", + "type": "string", "description": "Abbreviation" }, "email": { "title": "Email", + "type": "string", "description": "Email" }, "url": { "title": "URL", + "type": "string", "description": "URL" } }, @@ -490,14 +497,17 @@ }, "abbreviation": { "title": "Abbreviation", + "type": "string", "description": "Abbreviation" }, "email": { "title": "Email", + "type": "string", "description": "Email" }, "url": { "title": "URL", + "type": "string", "description": "URL" } }, @@ -507,29 +517,32 @@ } }, "reviews_comments": { - "type": "object", - "title": "Reviews and comments", - "description": "List and description of reviews and comments received on the project", - "properties": { - "comment_date": { - "title": "Date of the comment", - "description": "Date when the comment was provided", - "type": "string" - }, - "comment_by": { - "title": "Provider of the comment", - "description": "Name and title of the comment provider (individual or organization)", - "type": "string" - }, - "comment_description": { - "title": "Description of the comment", - "description": "A description of the comment", - "type": "string" - }, - "comment_response": { - "title": "Response on the comment", - "description": "Response by the primary investigator or research team on the comment", - "type": "string" + "type": "array", + "items": { + "type": "object", + "title": "Reviews and comments", + "description": "List and description of reviews and comments received on the project", + "properties": { + "comment_date": { + "title": "Date of the comment", + "description": "Date when the comment was provided", + "type": "string" + }, + "comment_by": { + "title": "Provider of the comment", + "description": "Name and title of the comment provider (individual or organization)", + "type": "string" + }, + "comment_description": { + "title": "Description of the comment", + "description": "A description of the comment", + "type": "string" + }, + "comment_response": { + "title": "Response on the comment", + "description": "Response by the primary investigator or research team on the comment", + "type": "string" + } } } }, @@ -652,27 +665,37 @@ } }, "themes": { - "title": "Themes", "type": "array", - "description": "Themes covered by the project (ideally, a controlled vocabulary should be used)", + "description": "Themes", "items": { "type": "object", "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, "name": { "title": "Name", - "description": "Theme label, typically extracted from a pre-defined taxonomy", + "type": "string" + }, + "parent_id": { + "title": "Parent Identifier", "type": "string" }, "vocabulary": { - "title": "Vocabulary name", - "description": "Vocabulary name (for themes extracted from controlled vocabularies)", + "title": "Vocabulary", + "description": "Name of the controlled vocabulary", "type": "string" }, "uri": { "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the theme is from a taxonomy.", "type": "string" } - } + }, + "required": [ + "name" + ] } }, "topics": { @@ -715,22 +738,31 @@ "disciplines": { "type": "array", "title": "Disciplines", - "description": "Disciplines e.g. `Social sciences, economics`, `Natural sciences, biology` (ideally, a controlled vocabulary should be used)", + "description": "Disciplines e.g. `Social sciences, economics`, `Natural sciences, biology`", "items": { "type": "object", "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, "name": { "title": "Discipline title or name", "type": "string" }, + "parent_id": { + "title": "Parent discipline Identifier", + "description": "Parent discipline ID", + "type": "string" + }, "vocabulary": { - "title": "Vocabulary name", - "description": "Vocabulary name (for disciplines extracted from controlled vocabularies)", + "title": "Vocabulary", + "description": "Vocabulary", "type": "string" }, "uri": { - "title": "Vocabulary URI", - "description": "Vocabulary uri", + "title": "URI", + "description": "Website link", "type": "string" } }, @@ -1016,20 +1048,24 @@ "title": "Name", "type": "string" }, + "role": { + "title": "Role", + "type": "string" + }, "affiliation": { "title": "Affiliation", "type": "string" }, - "role": { - "title": "Role", + "email": { + "title": "Email", "type": "string" }, - "uri": { - "title": "URI", + "telephone": { + "title": "Telephone", "type": "string" }, - "phone": { - "title": "Phone number", + "uri": { + "title": "URI", "type": "string" } } @@ -1037,8 +1073,8 @@ "required": [ "name" ] - } - } + } + } }, "provenance": { "type": "array", @@ -1068,6 +1104,136 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata", diff --git a/api-documentation/catalog-admin/survey-schema.json b/api-documentation/catalog-admin/survey-schema.json index 9cec126ee..1b484cddc 100644 --- a/api-documentation/catalog-admin/survey-schema.json +++ b/api-documentation/catalog-admin/survey-schema.json @@ -3,56 +3,61 @@ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Survey Microdata Schema", "id": "survey-schema.json", - "version" :"0.0", - "description": "Schema for Survey data type based on DDI 2.5", - "allOf": [ + "version": "0.0", + "description": "Schema for Survey data type based on DDI 2.5", + "allOf": [ { - "type": "object", - "properties": { - "repositoryid": { - "type": "string", - "title": "Collection ID that owns the survey", - "description": "Abbreviation for the collection that owns this survey." - }, - "access_policy": { - "type": "string", - "title": "Data access policy", - "description": "Data access policy for attached microdata resources", - "enum": [ - "direct", - "open", - "public", - "licensed", - "remote", - "data_na" - ], - "default": "data_na" - }, - "published": { - "type": "integer", - "description": "Status of the survey - 0=draft, 1=published", - "default": 0 - }, - "overwrite": { - "type": "string", - "description": "Overwrite survey if already exists?", - "enum":["yes","no"], - "default": "no" - } + "type": "object", + "properties": { + "repositoryid": { + "type": "string", + "title": "Collection ID that owns the survey", + "description": "Abbreviation for the collection that owns this survey." + }, + "access_policy": { + "type": "string", + "title": "Data access policy", + "description": "Data access policy for attached microdata resources", + "enum": [ + "direct", + "open", + "public", + "licensed", + "remote", + "data_na" + ], + "default": "data_na" + }, + "published": { + "type": "integer", + "description": "Status of the survey - 0=draft, 1=published", + "default": 0 + }, + "overwrite": { + "type": "string", + "description": "Overwrite survey if already exists?", + "enum": [ + "yes", + "no" + ], + "default": "no" } + } + }, + { + "$ref": "ddi-schema.json" }, - { "$ref": "ddi-schema.json" }, { "type": "object", - "properties": { - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" + "properties": { + "provenance": { + "type": "array", + "description": "Provenance", + "items": { + "$ref": "provenance-schema.json" } }, - "tags": { + "tags": { "type": "array", "title": "Tags (user-defined)", "description": "Tags", @@ -73,12 +78,148 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": [ + "integer", + "string" + ] + }, + "topic_score": { + "title": "Topic score", + "type": [ + "number", + "string" + ] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + }, + "additionalProperties": false + } + }, + "embeddings": { + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id", + "vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata not covered by DDI elements", "properties": {} } + } } - } -] + ] } \ No newline at end of file diff --git a/api-documentation/catalog-admin/table-schema.json b/api-documentation/catalog-admin/table-schema.json index b1c7ad573..6334fd3f7 100644 --- a/api-documentation/catalog-admin/table-schema.json +++ b/api-documentation/catalog-admin/table-schema.json @@ -133,6 +133,10 @@ "title": "Unique ID number for the document", "type": "string" }, + "title": { + "title": "Document title", + "type": "string" + }, "producers": { "type": "array", "title": "Producers", @@ -966,6 +970,136 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata", diff --git a/api-documentation/catalog-admin/timeseries-db-schema.json b/api-documentation/catalog-admin/timeseries-db-schema.json index b8e30c18b..7c7636e89 100644 --- a/api-documentation/catalog-admin/timeseries-db-schema.json +++ b/api-documentation/catalog-admin/timeseries-db-schema.json @@ -62,7 +62,7 @@ } } }, - "production_date": { + "prod_date": { "type": "string", "title": "Date of Production", "description": "Document production date using format(YYYY-MM-DD)" @@ -154,11 +154,13 @@ }, "abbreviation": { "title": "Abbreviation", - "description": "Abbreviation" + "description": "Abbreviation", + "type": "string" }, "email": { "title": "Email", - "description": "Email" + "description": "Email", + "type": "string" }, "uri": { "title": "URI", @@ -289,33 +291,40 @@ } } }, - "themes": { - "type": "array", - "title": "Themes", - "description": "Themes", + "themes":{ + "type":"array", + "description":"Themes", "items": { - "type": "object", - "properties": { - "name": { - "title": "Topic", - "type": "string" - }, - "vocabulary": { - "title": "Vocabulary", - "description": "Name of the controlled vocabulary, if the topic is from a taxonomy.", - "type": "string" - }, - "uri": { - "title": "Vocabulary URI", - "description": "Link to the controlled vocabulary web page, if the topic is from a taxonomy.", - "type": "string" - } + "type": "object", + "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" }, - "required": [ - "name" - ] + "name": { + "title": "Name", + "type": "string" + }, + "parent_id": { + "title": "Parent Identifier", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Name of the controlled vocabulary", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the theme is from a taxonomy.", + "type": "string" + } + }, + "required": [ + "name" + ] } - }, + }, "topics": { "type": "array", "title": "Topics", @@ -629,8 +638,8 @@ "items": { "type": "object", "properties": { - "type": { - "title": "Type", + "name": { + "title": "Name", "type": "string" }, "uri": { @@ -644,7 +653,7 @@ } }, "required": [ - "type" + "name" ] }, "citation": { diff --git a/api-documentation/catalog-admin/timeseries-schema.json b/api-documentation/catalog-admin/timeseries-schema.json index 2a7e2cf30..b3545b15e 100644 --- a/api-documentation/catalog-admin/timeseries-schema.json +++ b/api-documentation/catalog-admin/timeseries-schema.json @@ -49,6 +49,17 @@ "title": "Metadata creation", "description": "Information on who generated the documentation", "properties": { + "title": { + "title": "Document title", + "description": "Document title", + "type": "string", + "_ddi_xpath": "docDscr/citation/titlStmt/titl" + }, + "idno": { + "title": "Unique ID number for the document", + "type": "string", + "_ddi_xpath": "docDscr/citation/titlStmt/IDNo" + }, "producers": { "type": "array", "title": "Producers", @@ -101,6 +112,10 @@ "title": "Series unique ID", "description": "Unique series ID" }, + "doi": { + "type": "string", + "title": "DOI handle" + }, "name": { "type": "string", "title": "Series Name" @@ -155,6 +170,28 @@ ] } }, + "languages": { + "type": "array", + "description": "Supported languages", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Language title", + "type": "string" + }, + "code": { + "title": "code", + "Descripton": "Language code", + "type": "string" + } + } + }, + "required": [ + "name" + ] + }, "measurement_unit": { "type": "string", "title": "Series unit of measure" @@ -287,23 +324,36 @@ }, "themes": { "type": "array", - "title": "Themes", + "description": "Themes", "items": { "type": "object", "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, "name": { "title": "Name", "type": "string" }, + "parent_id": { + "title": "Parent Identifier", + "type": "string" + }, "vocabulary": { - "title": "Vocabulary name", + "title": "Vocabulary", + "description": "Name of the controlled vocabulary", "type": "string" }, "uri": { "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the theme is from a taxonomy.", "type": "string" } - } + }, + "required": [ + "name" + ] } }, "topics": { @@ -390,6 +440,24 @@ } } }, + "ref_country": { + "type": "array", + "title": "Reference country", + "description": "List of countries for which data are available", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Country name", + "type": "string" + }, + "code": { + "title": "Country code", + "type": "string" + } + } + } + }, "geographic_units": { "title": "Geographic locations", "description": "List of geographic units (regions, countries, states, provinces, etc.) for which data are available in the database.", @@ -452,18 +520,29 @@ "title": "Dissaggregation" }, "license": { - "type": "object", - "title": "Access licence", - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "uri": { - "type": "string", - "title": "URI" + "type": "array", + "title": "License", + "description": "License information", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + }, + "note": { + "title": "Note", + "type": "string" + } } - } + }, + "required": [ + "name" + ] }, "confidentiality": { "type": "string", @@ -685,9 +764,13 @@ "type": "string", "title": "Standard name" }, - "organization": { + "abbreviation": { + "type": "string", + "title": "Abbreviation" + }, + "custodian": { "type": "string", - "title": "Organization name" + "title": "Name of the custodian organization" }, "uri": { "type": "string", @@ -709,6 +792,14 @@ "type": "string", "title": "Name" }, + "abbreviation": { + "type": "string", + "title": "Abbreviation" + }, + "custodian": { + "type": "string", + "title": "Custodian" + }, "description": { "type": "string", "title": "Description" @@ -963,6 +1054,136 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "title": "Additional custom metadata", diff --git a/api-documentation/catalog-admin/variable-schema.json b/api-documentation/catalog-admin/variable-schema.json index 9d887e678..c29c7df68 100644 --- a/api-documentation/catalog-admin/variable-schema.json +++ b/api-documentation/catalog-admin/variable-schema.json @@ -1,6 +1,6 @@ { "$id": "http://ihsn.org/schemas/variable", - "$schema": "http://json-schema.org/draft-07/schema#", + "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "definitions": {}, "properties": { @@ -24,9 +24,12 @@ }, "var_intrvl": { "type": "string", - "title" : "Interval type", + "title": "Interval type", "description": "indicates the interval type; options are discrete or continuous.", - "enum": [ "discrete", "contin"] + "enum": [ + "discrete", + "contin" + ] }, "var_dcml": { "type": "string", @@ -35,10 +38,10 @@ }, "var_wgt": { "type": "integer", - "title":"Weight", + "title": "Weight", "description": "indicates whether the variable is a weight", "default": 0 - }, + }, "loc_start_pos": { "type": "integer", "title": "Variable start position" @@ -49,24 +52,22 @@ }, "loc_width": { "type": "integer", - "title": "Variable width" - }, + "title": "Variable width" + }, "loc_rec_seg_no": { "type": "integer", - "title": "Record segment number, deck or card number the variable is located on" - }, + "title": "Record segment number, deck or card number the variable is located on" + }, "var_imputation": { "type": "string", "title": "Imputation", "description": "According to the Statistical Terminology glossary maintained by the National Science Foundation, this is `the process by which one estimates missing values for items that a survey respondent failed to provide,` and if applicable in this context, it refers to the type of procedure used. " }, - "var_derivation": { "type": "string", "title": "Derivation", "description": "Used only in the case of a derived variable, this element provides both a description of how the derivation was performed and the command used to generate the derived variable, as well as a specification of the other variables in the study used to generate the derivation. The `var` attribute provides the ID values of the other variables in the study used to generate this derived variable." }, - "var_security": { "type": "string", "title": "Security" @@ -88,19 +89,16 @@ "type": "string", "title": "Post-question text" }, - "var_forward": { "type": "string", "title": "Forward skip", - "description":"Contains a reference to IDs of possible following questions. This can be used to document forward skip instructions." + "description": "Contains a reference to IDs of possible following questions. This can be used to document forward skip instructions." }, - "var_backward": { "type": "string", "title": "Backward skip", - "description":"Contains a reference to IDs of possible preceding questions. This can be used to document backward skip instructions." + "description": "Contains a reference to IDs of possible preceding questions. This can be used to document backward skip instructions." }, - "var_qstn_ivulnstr": { "type": "string", "title": "Interviewer instructions" @@ -110,8 +108,8 @@ "title": "Universe" }, "var_sumstat": { - "type": "array", - "description": "One or more statistical measures that describe the responses to a particular variable and may include one or more standard summaries, e.g., minimum and maximum values, median, mode, etc. \n\n The attribute 'type' denotes the type of statistics being shown: mean, median, mode, valid cases, invalid cases, minimum, maximum, or standard deviation.", + "type": "array", + "description": "One or more statistical measures that describe the responses to a particular variable and may include one or more standard summaries, e.g., minimum and maximum values, median, mode, etc. \n\n The attribute 'type' denotes the type of statistics being shown: mean, median, mode, valid cases, invalid cases, minimum, maximum, or standard deviation.", "items": { "type": "object", "properties": { @@ -120,7 +118,10 @@ "title": "Type" }, "value": { - "type": ["integer", "string"], + "type": [ + "integer", + "string" + ], "title": "Value" }, "wgtd": { @@ -136,8 +137,8 @@ "title": "Variable description" }, "var_catgry": { - "type": "array", - "title": "Categories", + "type": "array", + "title": "Categories", "items": { "type": "object", "properties": { @@ -162,45 +163,46 @@ "description": "Type such as frequency, percent, etc" }, "value": { - "type": ["integer", "string"], + "type": [ + "integer", + "string" + ], "title": "Value" }, "wgtd": { "type": "string", "title": "Weighted", "description": "For weighted values, enter `weighted`" - } + } } } } } } }, - "var_std_catgry": { "type": "object", "title": "Standard categories", - "description":"Standard category codes used in the variable, like industry codes, employment codes, or social class codes. The attribute `date` is provided to indicate the version of the code in place at the time of the study. The attribute `URI` is provided to indicate a URN or URL that can be used to obtain an electronic list of the category codes.", - "properties":{ + "description": "Standard category codes used in the variable, like industry codes, employment codes, or social class codes. The attribute `date` is provided to indicate the version of the code in place at the time of the study. The attribute `URI` is provided to indicate a URN or URL that can be used to obtain an electronic list of the category codes.", + "properties": { "name": { "title": "Standard classification name", "type": "string" - }, - "source": { + }, + "source": { "title": "Source", "type": "string" - }, - "date": { + }, + "date": { "title": "Date", "type": "string" - }, - "uri": { + }, + "uri": { "title": "URI", "type": "string" - } + } } }, - "var_codinstr": { "type": "string", "title": "Recoding and derivation" @@ -209,49 +211,54 @@ "type": "array", "title": "Concepts", "items": { - "type": "object", - "properties": { - "title": { - "title": "Concept", - "type": "string" + "type": "object", + "properties": { + "title": { + "title": "Concept", + "type": "string" + }, + "vocab": { + "title": "Vocabulary", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "type": "string" + } + }, + "required": [ + "title" + ] + } + }, + "var_format": { + "type": "object", + "title": "Variable format", + "description": "The technical format of the variable in question. Attributes for this element include: 'type', which indicates if the variable is character or numeric; 'formatname,' which in some cases may provide the name of the particular, proprietary format actually used; 'schema,' which identifies the vendor or standards body that defined the format (acceptable choices are SAS, SPSS, IBM, ANSI, ISO, XML-data or other); 'category,' which describes what kind of data the format represents, and includes date, time, currency, or 'other' conceptual possibilities.", + "properties": { + "type": { + "type": "string", + "title": "Type" }, - "vocab": { - "title": "Vocabulary", - "type": "string" + "name": { + "type": "string", + "title": "Name" }, - "uri": { - "title": "Vocabulary URI", - "type": "string" + "note": { + "type": "string", + "title": "Note" } - }, - "required": [ - "title" - ] } - }, - "var_format": { - "type": "object", - "title": "Variable format", - "description": "The technical format of the variable in question. Attributes for this element include: 'type', which indicates if the variable is character or numeric; 'formatname,' which in some cases may provide the name of the particular, proprietary format actually used; 'schema,' which identifies the vendor or standards body that defined the format (acceptable choices are SAS, SPSS, IBM, ANSI, ISO, XML-data or other); 'category,' which describes what kind of data the format represents, and includes date, time, currency, or 'other' conceptual possibilities.", - "properties": { - "type": { - "type": "string", - "title": "Type" - }, - "name": { - "type": "string", - "title": "Name" - }, - "note": { - "type": "string", - "title": "Note" - } - } - }, + }, "var_notes": { "type": "string", "title": "Variable notes" } - }, - "required": [ "vid", "file_id", "name","labl" ] + }, + "required": [ + "vid", + "file_id", + "name", + "labl" + ] } \ No newline at end of file diff --git a/api-documentation/catalog-admin/video-schema.json b/api-documentation/catalog-admin/video-schema.json index b7c37cd25..42243302c 100644 --- a/api-documentation/catalog-admin/video-schema.json +++ b/api-documentation/catalog-admin/video-schema.json @@ -338,6 +338,43 @@ "type": "string", "title": "Repository" }, + "contacts": { + "type": "array", + "title": "Contacts", + "description": "Contacts", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "email": { + "title": "Email", + "type": "string" + }, + "telephone": { + "title": "Telephone", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "name" + ] + }, "contributors": { "type": "array", @@ -370,7 +407,7 @@ ] } }, - "funder": { + "sponsors": { "type": "array", "title": "Funding Agency/Sponsor", "items": { @@ -440,7 +477,7 @@ }, "relations": { - "type": "string", + "type": "array", "title":"Defines, as a free text field, the relation between the video being documented and other resources. This is a Dublin Core element." }, @@ -592,6 +629,136 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", diff --git a/api-documentation/catalog-admin/visualization-schema.json b/api-documentation/catalog-admin/visualization-schema.json index 538f102d6..14aac2b7d 100644 --- a/api-documentation/catalog-admin/visualization-schema.json +++ b/api-documentation/catalog-admin/visualization-schema.json @@ -935,35 +935,7 @@ "required": [ "name" ] - }, - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" - } - }, - "tags": { - "type": "array", - "title": "Tags", - "description": "Tags", - "items": { - "type": "object", - "properties": { - "tag": { - "title": "Tag", - "type": "string" - }, - "tag_group": { - "title": "Tag group", - "type": "string" - } - } - }, - "required": [ - "tag" - ] - } + } }, "additionalProperties": false @@ -999,6 +971,164 @@ ] } }, + "provenance":{ + "type":"array", + "description":"Provenance", + "items":{ + "$ref":"provenance-schema.json" + } + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "Tags", + "items": { + "type": "object", + "properties": { + "tag": { + "title": "Tag", + "type": "string" + }, + "tag_group": { + "title": "Tag group", + "type": "string" + } + } + }, + "required": [ + "tag" + ] + }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata", diff --git a/application/schemas/document-schema.json b/application/schemas/document-schema.json index b85794a16..311756b1b 100644 --- a/application/schemas/document-schema.json +++ b/application/schemas/document-schema.json @@ -130,12 +130,10 @@ }, "alternate_title": { "type": "string", - "title": "Abbreviation or Acronym", - "description": "Any form of the title used as a substitute or alternative to the formal title of the resource." + "title": "Abbreviation or Acronym" }, - "abbreviated_title": { - "title": "Abbreviated Title", - "description": "Title as abbreviated for indexing or identification.", + "translated_title": { + "title": "Translated Title", "type": "string" } }, @@ -185,6 +183,11 @@ } } } + }, + "full_name": { + "title": "Full name", + "type": "string", + "description": "Full name of the author. This element to be used only when first or last name cannot be distinguished." } } }, @@ -586,7 +589,7 @@ }, "url": { - "type": "string", + "type": ["string", "array"], "title": "URL", "description":"URL of the document, preferably a permanent URL" }, @@ -733,30 +736,29 @@ }, "sources": { - "type": "object", + "type":"array", "title": "Sources", - "description": "Description of sources used. The element is nestable so that the sources statement might encompass a series of discrete source statements, each of which could contain the facts about an individual source. ", - "_ddi_xpath":"stdyDscr/method/dataColl/sources", + "description": "Description of sources used. The element is nestable so that the sources statement might encompass a series of discrete source statements, each of which could contain the facts about an individual source. ", + "items":{ + "type": "object", "properties": { "source_origin":{ "type":"string", "title":"Origin of Source", - "description":"For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. ", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcOrig" + "description":"For historical materials, information about the origin(s) of the sources and the rules followed in establishing the sources should be specified. May not be relevant to survey data. " }, "source_char":{ "type":"string", "title":"Characteristics of Source Noted", - "description":"Assessment of characteristics and quality of source material. May not be relevant to survey data.", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcChar" + "description":"Assessment of characteristics and quality of source material. May not be relevant to survey data." }, "source_doc":{ "type":"string", "title":"Source documentation", - "description":"Documentation and Access to Sources", - "_ddi_xpath":"stdyDscr/method/dataColl/sources/srcDocu" + "description":"Documentation and Access to Sources" } } + } }, "data_sources":{ @@ -982,138 +984,7 @@ } } } - }, - - "lda_topics": { - "type": "array", - "title": "LDA topics", - "description": "LDA topics", - "items": { - "type": "object", - "properties": { - "model_info": { - "type": "array", - "title": "Model information", - "items": { - "type": "object", - "properties": { - "source": { - "title": "Source", - "type": "string" - }, - "author": { - "title": "Author", - "type": "string" - }, - "version": { - "title": "Version", - "type": "string" - }, - "model_id": { - "title": "Model Identifier", - "type": "string" - }, - "nb_topics": { - "title": "Number of topics", - "type": "number" - }, - "description": { - "title": "Description", - "type": "string" - }, - "corpus": { - "title": "Corpus name", - "type": "string" - }, - "uri": { - "title": "URI", - "type": "string" - } - } - }, - "required": [ - "model_id" - ] - }, - "topic_description": { - "type": "array", - "title": "Topic information", - "items": { - "type": "object", - "properties": { - "topic_id": { - "title": "Topic identifier", - "type": ["integer", "string"] - }, - "topic_score": { - "title": "Topic score", - "type": ["number", "string"] - }, - "topic_label": { - "title": "Topic label", - "type": "string" - }, - "topic_words": { - "type": "array", - "title": "Topic words", - "description": "Words", - "items": { - "type": "object", - "properties": { - "word": { - "title": "Word", - "type": "string" - }, - "word_weight": { - "title": "Word weight", - "type": "number" - } - } - }, - "required": [ - "word" - ] - } - } - }, - "required": [ - "topic_id" - ] - } - - }, - "additionalProperties": false - } - }, - "embeddings":{ - "type": "array", - "title": "Word embeddings", - "description": "Word embeddings", - "items": { - "type": "object", - "properties": { - "id": { - "title": "Vector Model ID", - "type": "string" - }, - "description": { - "title": "Vector Model Description", - "type": "string" - }, - "date": { - "title": "Date (YYYY-MM-DD)", - "type": "string" - }, - "vector": { - "title": "Vector", - "type": "object" - } - }, - "required": [ - "id","vector" - ] - } - } + } }, "required":["title_statement"], "additionalProperties": false @@ -1146,6 +1017,136 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata", diff --git a/application/schemas/geospatial-schema.json b/application/schemas/geospatial-schema.json index 67d68df1a..ef94c08d5 100644 --- a/application/schemas/geospatial-schema.json +++ b/application/schemas/geospatial-schema.json @@ -2027,7 +2027,137 @@ "required": [ "tag" ] - }, + }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "title": "Additional metadata", "description": "Any additional metadata", diff --git a/application/schemas/image-schema.json b/application/schemas/image-schema.json index de8188bf2..01be446d4 100644 --- a/application/schemas/image-schema.json +++ b/application/schemas/image-schema.json @@ -165,28 +165,7 @@ } } } - }, - "tags": { - "type": "array", - "title": "Tags", - "description": "Tags", - "items": { - "type": "object", - "properties": { - "tag": { - "title": "Tag", - "type": "string" - }, - "tag_group": { - "title": "Tag group", - "type": "string" - } - } - }, - "required": [ - "tag" - ] - } + } } }, "provenance":{ @@ -196,6 +175,157 @@ "$ref":"provenance-schema.json" } }, + "tags": { + "type": "array", + "title": "Tags", + "description": "Tags", + "items": { + "type": "object", + "properties": { + "tag": { + "title": "Tag", + "type": "string" + }, + "tag_group": { + "title": "Tag group", + "type": "string" + } + } + }, + "required": [ + "tag" + ] + }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata", diff --git a/application/schemas/script-schema.json b/application/schemas/script-schema.json index 0a87296ee..d2dbfc4c1 100644 --- a/application/schemas/script-schema.json +++ b/application/schemas/script-schema.json @@ -96,6 +96,28 @@ "title": "Unique user defined ID", "description": "The ID number of a research project is a unique number that is used to identify a particular project. Define and use a consistent scheme to use." }, + "identifiers": { + "type": "array", + "title": "Other identifiers", + "description": "Other identifiers", + "items": { + "type": "object", + "properties": { + "type": { + "title": "Identifier type", + "description": "Type of identifier e.g. `doi`, `handle`, `other`", + "type": "string" + }, + "identifier": { + "title": "Identifier", + "type": "string" + } + }, + "required": [ + "identifier" + ] + } + }, "title": { "type": "string", "title": "Project title", @@ -275,19 +297,22 @@ } }, "errata": { - "type": "object", + "type": "array", "title": "Errata", "description": "List of corrected errors in data, scripts or output", - "properties": { - "erratum_date": { - "title": "Date of erratum", - "description": "Date when the erratum was reported or published", - "type": "string" - }, - "erratum_description": { - "title": "Description of the erratum", - "description": "A description of the erratum, with information on which data, scripts, or output were impacted", - "type": "string" + "items": { + "type": "object", + "properties": { + "date": { + "title": "Date of erratum", + "description": "Date when the erratum was reported or published", + "type": "string" + }, + "description": { + "title": "Description of the erratum", + "description": "A description of the erratum, with information on which data, scripts, or output were impacted", + "type": "string" + } } } }, @@ -344,10 +369,12 @@ }, "abbreviation": { "title": "Abbreviation", - "description": "Abbreviation" + "description": "Abbreviation", + "type": "string" }, "email": { "title": "Email", + "type": "string", "description": "Email" }, "author_id": { @@ -359,10 +386,12 @@ "properties": { "type": { "title": "Type", + "type": "string", "description": "Source of identifier, e.g. ORCID" }, "id": { "title": "Identifier", + "type": "string", "description": "Author's unique identifier for the corresponding source" } } @@ -382,7 +411,7 @@ "type": "object", "properties": { "name": { - "title": "N`ame", + "title": "Name", "type": "string", "description": "Name of the person, corporate body, or agency responsible for the work's substantive and intellectual content. If a person, invert first and last name and use commas." }, @@ -397,14 +426,17 @@ }, "abbreviation": { "title": "Abbreviation", + "type": "string", "description": "Abbreviation" }, "email": { "title": "Email", + "type": "string", "description": "Email" }, "url": { "title": "URL", + "type": "string", "description": "URL" } }, @@ -465,14 +497,17 @@ }, "abbreviation": { "title": "Abbreviation", + "type": "string", "description": "Abbreviation" }, "email": { "title": "Email", + "type": "string", "description": "Email" }, "url": { "title": "URL", + "type": "string", "description": "URL" } }, @@ -482,29 +517,32 @@ } }, "reviews_comments": { - "type": "object", - "title": "Reviews and comments", - "description": "List and description of reviews and comments received on the project", - "properties": { - "comment_date": { - "title": "Date of the comment", - "description": "Date when the comment was provided", - "type": "string" - }, - "comment_by": { - "title": "Provider of the comment", - "description": "Name and title of the comment provider (individual or organization)", - "type": "string" - }, - "comment_description": { - "title": "Description of the comment", - "description": "A description of the comment", - "type": "string" - }, - "comment_response": { - "title": "Response on the comment", - "description": "Response by the primary investigator or research team on the comment", - "type": "string" + "type": "array", + "items": { + "type": "object", + "title": "Reviews and comments", + "description": "List and description of reviews and comments received on the project", + "properties": { + "comment_date": { + "title": "Date of the comment", + "description": "Date when the comment was provided", + "type": "string" + }, + "comment_by": { + "title": "Provider of the comment", + "description": "Name and title of the comment provider (individual or organization)", + "type": "string" + }, + "comment_description": { + "title": "Description of the comment", + "description": "A description of the comment", + "type": "string" + }, + "comment_response": { + "title": "Response on the comment", + "description": "Response by the primary investigator or research team on the comment", + "type": "string" + } } } }, @@ -538,6 +576,18 @@ "description": "Acknowledgement statement", "type": "string" }, + "disclaimer": { + "title": "Disclaimer", + "type": "string" + }, + "confidentiality": { + "title": "Confidentiality", + "type": "string" + }, + "citation_requirement": { + "type": "string", + "description": "Citation requirement (can include a specific recommended citation)" + }, "related_projects": { "type": "array", "title": "Related research projects", @@ -615,27 +665,37 @@ } }, "themes": { - "title": "Themes", "type": "array", - "description": "Themes covered by the project (ideally, a controlled vocabulary should be used)", + "description": "Themes", "items": { "type": "object", "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, "name": { "title": "Name", - "description": "Theme label, typically extracted from a pre-defined taxonomy", + "type": "string" + }, + "parent_id": { + "title": "Parent Identifier", "type": "string" }, "vocabulary": { - "title": "Vocabulary name", - "description": "Vocabulary name (for themes extracted from controlled vocabularies)", + "title": "Vocabulary", + "description": "Name of the controlled vocabulary", "type": "string" }, "uri": { "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the theme is from a taxonomy.", "type": "string" } - } + }, + "required": [ + "name" + ] } }, "topics": { @@ -678,22 +738,31 @@ "disciplines": { "type": "array", "title": "Disciplines", - "description": "Disciplines e.g. `Social sciences, economics`, `Natural sciences, biology` (ideally, a controlled vocabulary should be used)", + "description": "Disciplines e.g. `Social sciences, economics`, `Natural sciences, biology`", "items": { "type": "object", "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, "name": { "title": "Discipline title or name", "type": "string" }, + "parent_id": { + "title": "Parent discipline Identifier", + "description": "Parent discipline ID", + "type": "string" + }, "vocabulary": { - "title": "Vocabulary name", - "description": "Vocabulary name (for disciplines extracted from controlled vocabularies)", + "title": "Vocabulary", + "description": "Vocabulary", "type": "string" }, "uri": { - "title": "Vocabulary URI", - "description": "Vocabulary uri", + "title": "URI", + "description": "Website link", "type": "string" } }, @@ -747,6 +816,10 @@ } } }, + "copyright": { + "title": "Copyright", + "type": "string" + }, "technology_environment": { "title": "Technology environment", "description": "Notes about the technology environment used by the authors to implement the project", @@ -808,7 +881,7 @@ }, "additionalProperties": false }, - "required": [ + "required": [ "name" ] }, @@ -975,20 +1048,24 @@ "title": "Name", "type": "string" }, + "role": { + "title": "Role", + "type": "string" + }, "affiliation": { "title": "Affiliation", "type": "string" }, - "role": { - "title": "Role", + "email": { + "title": "Email", "type": "string" }, - "uri": { - "title": "URI", + "telephone": { + "title": "Telephone", "type": "string" }, - "phone": { - "title": "Phone number", + "uri": { + "title": "URI", "type": "string" } } @@ -996,52 +1073,171 @@ "required": [ "name" ] - }, - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" - } + } + } + }, + "provenance": { + "type": "array", + "description": "Provenance", + "items": { + "$ref": "provenance-schema.json" + } + }, + "tags": { + "type": "array", + "title": "Tags (user-defined)", + "description": "Tags", + "items": { + "type": "object", + "properties": { + "tag": { + "title": "Tag", + "type": "string" }, - "tags": { - "type": "array", - "title": "Tags (user-defined)", - "description": "Tags", - "items": { - "type": "object", - "properties": { - "tag": { - "title": "Tag", - "type": "string" - }, - "tag_group": { - "title": "Tag group", - "type": "string" + "tag_group": { + "title": "Tag group", + "type": "string" + } + } + }, + "required": [ + "tag" + ] + }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } } - } - }, - "required": [ - "tag" - ] - }, - "copyright": { - "title": "Copyright", - "type": "string" - }, - "disclaimer": { - "title": "Disclaimer", - "type": "string" + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + }, - "confidentiality": { - "title": "Confidentiality", - "type": "string" + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } }, - "citation_requirement": { - "type": "string", - "description": "Citation requirement (can include a specific recommended citation)" - } + "required": [ + "id","vector" + ] } + }, + "additional": { + "type": "object", + "description": "Additional metadata", + "properties": {} } } } \ No newline at end of file diff --git a/application/schemas/survey-schema.json b/application/schemas/survey-schema.json index 9cec126ee..1b484cddc 100644 --- a/application/schemas/survey-schema.json +++ b/application/schemas/survey-schema.json @@ -3,56 +3,61 @@ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Survey Microdata Schema", "id": "survey-schema.json", - "version" :"0.0", - "description": "Schema for Survey data type based on DDI 2.5", - "allOf": [ + "version": "0.0", + "description": "Schema for Survey data type based on DDI 2.5", + "allOf": [ { - "type": "object", - "properties": { - "repositoryid": { - "type": "string", - "title": "Collection ID that owns the survey", - "description": "Abbreviation for the collection that owns this survey." - }, - "access_policy": { - "type": "string", - "title": "Data access policy", - "description": "Data access policy for attached microdata resources", - "enum": [ - "direct", - "open", - "public", - "licensed", - "remote", - "data_na" - ], - "default": "data_na" - }, - "published": { - "type": "integer", - "description": "Status of the survey - 0=draft, 1=published", - "default": 0 - }, - "overwrite": { - "type": "string", - "description": "Overwrite survey if already exists?", - "enum":["yes","no"], - "default": "no" - } + "type": "object", + "properties": { + "repositoryid": { + "type": "string", + "title": "Collection ID that owns the survey", + "description": "Abbreviation for the collection that owns this survey." + }, + "access_policy": { + "type": "string", + "title": "Data access policy", + "description": "Data access policy for attached microdata resources", + "enum": [ + "direct", + "open", + "public", + "licensed", + "remote", + "data_na" + ], + "default": "data_na" + }, + "published": { + "type": "integer", + "description": "Status of the survey - 0=draft, 1=published", + "default": 0 + }, + "overwrite": { + "type": "string", + "description": "Overwrite survey if already exists?", + "enum": [ + "yes", + "no" + ], + "default": "no" } + } + }, + { + "$ref": "ddi-schema.json" }, - { "$ref": "ddi-schema.json" }, { "type": "object", - "properties": { - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" + "properties": { + "provenance": { + "type": "array", + "description": "Provenance", + "items": { + "$ref": "provenance-schema.json" } }, - "tags": { + "tags": { "type": "array", "title": "Tags (user-defined)", "description": "Tags", @@ -73,12 +78,148 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": [ + "integer", + "string" + ] + }, + "topic_score": { + "title": "Topic score", + "type": [ + "number", + "string" + ] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + }, + "additionalProperties": false + } + }, + "embeddings": { + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id", + "vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata not covered by DDI elements", "properties": {} } + } } - } -] + ] } \ No newline at end of file diff --git a/application/schemas/table-schema.json b/application/schemas/table-schema.json index b1c7ad573..6334fd3f7 100644 --- a/application/schemas/table-schema.json +++ b/application/schemas/table-schema.json @@ -133,6 +133,10 @@ "title": "Unique ID number for the document", "type": "string" }, + "title": { + "title": "Document title", + "type": "string" + }, "producers": { "type": "array", "title": "Producers", @@ -966,6 +970,136 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata", diff --git a/application/schemas/timeseries-db-schema.json b/application/schemas/timeseries-db-schema.json index b8e30c18b..7c7636e89 100644 --- a/application/schemas/timeseries-db-schema.json +++ b/application/schemas/timeseries-db-schema.json @@ -62,7 +62,7 @@ } } }, - "production_date": { + "prod_date": { "type": "string", "title": "Date of Production", "description": "Document production date using format(YYYY-MM-DD)" @@ -154,11 +154,13 @@ }, "abbreviation": { "title": "Abbreviation", - "description": "Abbreviation" + "description": "Abbreviation", + "type": "string" }, "email": { "title": "Email", - "description": "Email" + "description": "Email", + "type": "string" }, "uri": { "title": "URI", @@ -289,33 +291,40 @@ } } }, - "themes": { - "type": "array", - "title": "Themes", - "description": "Themes", + "themes":{ + "type":"array", + "description":"Themes", "items": { - "type": "object", - "properties": { - "name": { - "title": "Topic", - "type": "string" - }, - "vocabulary": { - "title": "Vocabulary", - "description": "Name of the controlled vocabulary, if the topic is from a taxonomy.", - "type": "string" - }, - "uri": { - "title": "Vocabulary URI", - "description": "Link to the controlled vocabulary web page, if the topic is from a taxonomy.", - "type": "string" - } + "type": "object", + "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" }, - "required": [ - "name" - ] + "name": { + "title": "Name", + "type": "string" + }, + "parent_id": { + "title": "Parent Identifier", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Name of the controlled vocabulary", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the theme is from a taxonomy.", + "type": "string" + } + }, + "required": [ + "name" + ] } - }, + }, "topics": { "type": "array", "title": "Topics", @@ -629,8 +638,8 @@ "items": { "type": "object", "properties": { - "type": { - "title": "Type", + "name": { + "title": "Name", "type": "string" }, "uri": { @@ -644,7 +653,7 @@ } }, "required": [ - "type" + "name" ] }, "citation": { diff --git a/application/schemas/timeseries-schema.json b/application/schemas/timeseries-schema.json index 2a7e2cf30..b3545b15e 100644 --- a/application/schemas/timeseries-schema.json +++ b/application/schemas/timeseries-schema.json @@ -49,6 +49,17 @@ "title": "Metadata creation", "description": "Information on who generated the documentation", "properties": { + "title": { + "title": "Document title", + "description": "Document title", + "type": "string", + "_ddi_xpath": "docDscr/citation/titlStmt/titl" + }, + "idno": { + "title": "Unique ID number for the document", + "type": "string", + "_ddi_xpath": "docDscr/citation/titlStmt/IDNo" + }, "producers": { "type": "array", "title": "Producers", @@ -101,6 +112,10 @@ "title": "Series unique ID", "description": "Unique series ID" }, + "doi": { + "type": "string", + "title": "DOI handle" + }, "name": { "type": "string", "title": "Series Name" @@ -155,6 +170,28 @@ ] } }, + "languages": { + "type": "array", + "description": "Supported languages", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Language title", + "type": "string" + }, + "code": { + "title": "code", + "Descripton": "Language code", + "type": "string" + } + } + }, + "required": [ + "name" + ] + }, "measurement_unit": { "type": "string", "title": "Series unit of measure" @@ -287,23 +324,36 @@ }, "themes": { "type": "array", - "title": "Themes", + "description": "Themes", "items": { "type": "object", "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, "name": { "title": "Name", "type": "string" }, + "parent_id": { + "title": "Parent Identifier", + "type": "string" + }, "vocabulary": { - "title": "Vocabulary name", + "title": "Vocabulary", + "description": "Name of the controlled vocabulary", "type": "string" }, "uri": { "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the theme is from a taxonomy.", "type": "string" } - } + }, + "required": [ + "name" + ] } }, "topics": { @@ -390,6 +440,24 @@ } } }, + "ref_country": { + "type": "array", + "title": "Reference country", + "description": "List of countries for which data are available", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Country name", + "type": "string" + }, + "code": { + "title": "Country code", + "type": "string" + } + } + } + }, "geographic_units": { "title": "Geographic locations", "description": "List of geographic units (regions, countries, states, provinces, etc.) for which data are available in the database.", @@ -452,18 +520,29 @@ "title": "Dissaggregation" }, "license": { - "type": "object", - "title": "Access licence", - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "uri": { - "type": "string", - "title": "URI" + "type": "array", + "title": "License", + "description": "License information", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + }, + "note": { + "title": "Note", + "type": "string" + } } - } + }, + "required": [ + "name" + ] }, "confidentiality": { "type": "string", @@ -685,9 +764,13 @@ "type": "string", "title": "Standard name" }, - "organization": { + "abbreviation": { + "type": "string", + "title": "Abbreviation" + }, + "custodian": { "type": "string", - "title": "Organization name" + "title": "Name of the custodian organization" }, "uri": { "type": "string", @@ -709,6 +792,14 @@ "type": "string", "title": "Name" }, + "abbreviation": { + "type": "string", + "title": "Abbreviation" + }, + "custodian": { + "type": "string", + "title": "Custodian" + }, "description": { "type": "string", "title": "Description" @@ -963,6 +1054,136 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "title": "Additional custom metadata", diff --git a/application/schemas/variable-schema.json b/application/schemas/variable-schema.json index 9d887e678..c29c7df68 100644 --- a/application/schemas/variable-schema.json +++ b/application/schemas/variable-schema.json @@ -1,6 +1,6 @@ { "$id": "http://ihsn.org/schemas/variable", - "$schema": "http://json-schema.org/draft-07/schema#", + "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "definitions": {}, "properties": { @@ -24,9 +24,12 @@ }, "var_intrvl": { "type": "string", - "title" : "Interval type", + "title": "Interval type", "description": "indicates the interval type; options are discrete or continuous.", - "enum": [ "discrete", "contin"] + "enum": [ + "discrete", + "contin" + ] }, "var_dcml": { "type": "string", @@ -35,10 +38,10 @@ }, "var_wgt": { "type": "integer", - "title":"Weight", + "title": "Weight", "description": "indicates whether the variable is a weight", "default": 0 - }, + }, "loc_start_pos": { "type": "integer", "title": "Variable start position" @@ -49,24 +52,22 @@ }, "loc_width": { "type": "integer", - "title": "Variable width" - }, + "title": "Variable width" + }, "loc_rec_seg_no": { "type": "integer", - "title": "Record segment number, deck or card number the variable is located on" - }, + "title": "Record segment number, deck or card number the variable is located on" + }, "var_imputation": { "type": "string", "title": "Imputation", "description": "According to the Statistical Terminology glossary maintained by the National Science Foundation, this is `the process by which one estimates missing values for items that a survey respondent failed to provide,` and if applicable in this context, it refers to the type of procedure used. " }, - "var_derivation": { "type": "string", "title": "Derivation", "description": "Used only in the case of a derived variable, this element provides both a description of how the derivation was performed and the command used to generate the derived variable, as well as a specification of the other variables in the study used to generate the derivation. The `var` attribute provides the ID values of the other variables in the study used to generate this derived variable." }, - "var_security": { "type": "string", "title": "Security" @@ -88,19 +89,16 @@ "type": "string", "title": "Post-question text" }, - "var_forward": { "type": "string", "title": "Forward skip", - "description":"Contains a reference to IDs of possible following questions. This can be used to document forward skip instructions." + "description": "Contains a reference to IDs of possible following questions. This can be used to document forward skip instructions." }, - "var_backward": { "type": "string", "title": "Backward skip", - "description":"Contains a reference to IDs of possible preceding questions. This can be used to document backward skip instructions." + "description": "Contains a reference to IDs of possible preceding questions. This can be used to document backward skip instructions." }, - "var_qstn_ivulnstr": { "type": "string", "title": "Interviewer instructions" @@ -110,8 +108,8 @@ "title": "Universe" }, "var_sumstat": { - "type": "array", - "description": "One or more statistical measures that describe the responses to a particular variable and may include one or more standard summaries, e.g., minimum and maximum values, median, mode, etc. \n\n The attribute 'type' denotes the type of statistics being shown: mean, median, mode, valid cases, invalid cases, minimum, maximum, or standard deviation.", + "type": "array", + "description": "One or more statistical measures that describe the responses to a particular variable and may include one or more standard summaries, e.g., minimum and maximum values, median, mode, etc. \n\n The attribute 'type' denotes the type of statistics being shown: mean, median, mode, valid cases, invalid cases, minimum, maximum, or standard deviation.", "items": { "type": "object", "properties": { @@ -120,7 +118,10 @@ "title": "Type" }, "value": { - "type": ["integer", "string"], + "type": [ + "integer", + "string" + ], "title": "Value" }, "wgtd": { @@ -136,8 +137,8 @@ "title": "Variable description" }, "var_catgry": { - "type": "array", - "title": "Categories", + "type": "array", + "title": "Categories", "items": { "type": "object", "properties": { @@ -162,45 +163,46 @@ "description": "Type such as frequency, percent, etc" }, "value": { - "type": ["integer", "string"], + "type": [ + "integer", + "string" + ], "title": "Value" }, "wgtd": { "type": "string", "title": "Weighted", "description": "For weighted values, enter `weighted`" - } + } } } } } } }, - "var_std_catgry": { "type": "object", "title": "Standard categories", - "description":"Standard category codes used in the variable, like industry codes, employment codes, or social class codes. The attribute `date` is provided to indicate the version of the code in place at the time of the study. The attribute `URI` is provided to indicate a URN or URL that can be used to obtain an electronic list of the category codes.", - "properties":{ + "description": "Standard category codes used in the variable, like industry codes, employment codes, or social class codes. The attribute `date` is provided to indicate the version of the code in place at the time of the study. The attribute `URI` is provided to indicate a URN or URL that can be used to obtain an electronic list of the category codes.", + "properties": { "name": { "title": "Standard classification name", "type": "string" - }, - "source": { + }, + "source": { "title": "Source", "type": "string" - }, - "date": { + }, + "date": { "title": "Date", "type": "string" - }, - "uri": { + }, + "uri": { "title": "URI", "type": "string" - } + } } }, - "var_codinstr": { "type": "string", "title": "Recoding and derivation" @@ -209,49 +211,54 @@ "type": "array", "title": "Concepts", "items": { - "type": "object", - "properties": { - "title": { - "title": "Concept", - "type": "string" + "type": "object", + "properties": { + "title": { + "title": "Concept", + "type": "string" + }, + "vocab": { + "title": "Vocabulary", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "type": "string" + } + }, + "required": [ + "title" + ] + } + }, + "var_format": { + "type": "object", + "title": "Variable format", + "description": "The technical format of the variable in question. Attributes for this element include: 'type', which indicates if the variable is character or numeric; 'formatname,' which in some cases may provide the name of the particular, proprietary format actually used; 'schema,' which identifies the vendor or standards body that defined the format (acceptable choices are SAS, SPSS, IBM, ANSI, ISO, XML-data or other); 'category,' which describes what kind of data the format represents, and includes date, time, currency, or 'other' conceptual possibilities.", + "properties": { + "type": { + "type": "string", + "title": "Type" }, - "vocab": { - "title": "Vocabulary", - "type": "string" + "name": { + "type": "string", + "title": "Name" }, - "uri": { - "title": "Vocabulary URI", - "type": "string" + "note": { + "type": "string", + "title": "Note" } - }, - "required": [ - "title" - ] } - }, - "var_format": { - "type": "object", - "title": "Variable format", - "description": "The technical format of the variable in question. Attributes for this element include: 'type', which indicates if the variable is character or numeric; 'formatname,' which in some cases may provide the name of the particular, proprietary format actually used; 'schema,' which identifies the vendor or standards body that defined the format (acceptable choices are SAS, SPSS, IBM, ANSI, ISO, XML-data or other); 'category,' which describes what kind of data the format represents, and includes date, time, currency, or 'other' conceptual possibilities.", - "properties": { - "type": { - "type": "string", - "title": "Type" - }, - "name": { - "type": "string", - "title": "Name" - }, - "note": { - "type": "string", - "title": "Note" - } - } - }, + }, "var_notes": { "type": "string", "title": "Variable notes" } - }, - "required": [ "vid", "file_id", "name","labl" ] + }, + "required": [ + "vid", + "file_id", + "name", + "labl" + ] } \ No newline at end of file diff --git a/application/schemas/video-schema.json b/application/schemas/video-schema.json index 9a979015e..42243302c 100644 --- a/application/schemas/video-schema.json +++ b/application/schemas/video-schema.json @@ -126,33 +126,60 @@ "type": "string", "description": "Genre" }, - "keywords": { - "type": "string", - "description": "Keywords" - }, - - "topics":{ + "keywords":{ "type":"array", - "title":"Topic Classification", - "description":"Topic Classification", "items":{ "type":"object", "properties":{ - "topic":{ - "title":"Topic", + "name":{ + "title":"Name", "type":"string" }, - "vocab":{ - "title":"Vocab", + "vocabulary":{ + "title":"Vocabulary name", "type":"string" }, "uri":{ - "title":"URI", + "title":"Vocabulary URI", "type":"string" } + } + } + }, + + "topics": { + "type": "array", + "title": "Topics", + "description": "Topics covered by the table (ideally, the list of topics will be a controlled vocabulary)", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Unique Identifier", + "type": "string" + }, + "name": { + "title": "Topic", + "type": "string" + }, + "parent_id": { + "title": "Parent topic Identifier", + "description":"For subtopics, provide the ID of the parent topic", + "type": "string" + }, + "vocabulary": { + "title": "Vocabulary", + "description": "Name of the controlled vocabulary, if the topic is from a taxonomy.", + "type": "string" + }, + "uri": { + "title": "Vocabulary URI", + "description": "Link to the controlled vocabulary web page, if the topic is from a taxonomy.", + "type": "string" + } }, - "required":[ - "topic" + "required": [ + "name" ] } }, @@ -182,34 +209,40 @@ "description": "Primary entity described in the video" }, - "video_provider": { - "type": "string", - "description": "Video provider e.g. youtube, vimeo, facebook" - }, - - "video_url": { + "date_created": { "type": "string", - "description": "Video URL" + "description": "Date of creation (YYYY-MM-DD)" }, - - "embed_url": { + "date_published": { "type": "string", - "description": "Video embed URL" + "description": "Date published (YYYY-MM-DD)" }, - "encoding_format": { + "version": { "type": "string", - "title":"Encoding format", - "description": "Media type using a MIME format" + "description": "Version" }, - "duration": { + "status": { "type": "string", - "title":"Duration", - "description": "The duration of the video in ISO 8601 date time format - `hh:mm:ss`" + "title":"Creative work status", + "description": "Status of a creative work in terms of its stage in lifecycle. e.g. `incomplete`, `draft`, `published`, `obsolete`" }, - "content_location": { - "type": "string", - "description": "Location depicted or described in the video" + "country": { + "type": "array", + "title": "Countries", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Country name", + "type": "string" + }, + "code": { + "title": "Country code", + "type": "string" + } + } + } }, "spatial_coverage": { @@ -227,39 +260,250 @@ "description": "Period that the content applies to using ISO 8601 date time format" }, + "recorded_at": { + "type": "string", + "description": "Location where video was recorded" + }, + "audience": { "type": "string", "description": "Intended audience" }, - - "country": { - "type": "string", - "description": "Country" + + "bbox": { + "title": "Geographic bounding box", + "type": "array", + "items": { + "type": "object", + "properties": { + "west": { + "title": "West", + "type": "string" + }, + "east": { + "title": "East", + "type": "string" + }, + "south": { + "title": "South", + "type": "string" + }, + "north": { + "title": "North", + "type": "string" + } + } + } }, + "language": { + "type": "array", + "description": "languages", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Language name", + "type": "string" + }, + "code": { + "title": "code", + "Descripton": "Language code", + "type": "string" + } + } + }, + "required": [ + "name" + ] + }, + + "creator": { "type": "string", - "description": "Language" + "description": "Creator" }, - "author": { + + "production_company": { "type": "string", - "description": "Author" + "description": "Production company" }, + "publisher": { "type": "string", "description": "Publisher" }, - "contributor": { + + "repository": { + "type": "string", + "title": "Repository" + }, + "contacts": { + "type": "array", + "title": "Contacts", + "description": "Contacts", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "email": { + "title": "Email", + "type": "string" + }, + "telephone": { + "title": "Telephone", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "name" + ] + }, + + "contributors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + }, + "abbreviation": { + "title": "Abbreviation", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + "sponsors": { + "type": "array", + "title": "Funding Agency/Sponsor", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Funding Agency/Sponsor", + "type": "string" + }, + "abbr": { + "title": "Abbreviation", + "type": "string" + }, + "grant": { + "title": "Grant Number", + "type": "string" + }, + "role": { + "title": "Role", + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + + "translators": { + "type": "array", + "title": "Translators", + "description": "Translators", + "items": { + "type": "object", + "properties": { + "first_name": { + "title": "First name", + "type": "string" + }, + "initial": { + "title": "Initial", + "type": "string" + }, + "last_name": { + "title": "Last name", + "type": "string" + }, + "affiliation": { + "title": "Affiliation", + "type": "string" + } + } + }, + "required": [ + "first_name" + ] + }, + + "is_based_on": { + "type": "string", + "title":"A resource from which this work is derived", + "description": "A resource from which this work is derived or from which it is a modification or adaption" + }, + "is_part_of": { + "type": "string", + "title":"Indicate an item that this item is part of" + }, + + "relations": { + "type": "array", + "title":"Defines, as a free text field, the relation between the video being documented and other resources. This is a Dublin Core element." + }, + + "video_provider": { "type": "string", - "description": "Contributor" + "description": "Video provider e.g. youtube, vimeo, facebook" }, - "funder": { + + "video_url": { "type": "string", - "description": "Funder" + "description": "Video URL" }, - "translator": { + + "embed_url": { "type": "string", - "title": "Translator", - "description": "Organization or person who adapts a creative work to different languages" + "description": "Video embed URL" + }, + "encoding_format": { + "type": "string", + "title":"Encoding format", + "description": "Media type using a MIME format" + }, + "duration": { + "type": "string", + "title":"Duration", + "description": "The duration of the video in ISO 8601 date time format - `hh:mm:ss`" }, "rights": { "type": "string", @@ -283,34 +527,73 @@ "description": "Year during which claimed copyright for the video was first asserted" }, - - - "date_created": { - "type": "string", - "description": "Date of creation (YYYY-MM-DD)" - }, - "date_published": { + "credit_text": { "type": "string", - "description": "Date published (YYYY-MM-DD)" + "title": "Credits", + "description": "This element that can be used to credit the person(s) and/or organization(s) associated with a published video. It corresponds to the `creditText` element of VideoObject." }, - "version": { + + "citation": { "type": "string", - "description": "Version" + "title": "Citation", + "description": "This element provides a required or recommended citation of the audio file." }, - "status": { - "type": "string", - "title":"Creative work status", - "description": "Status of a creative work in terms of its stage in lifecycle. e.g. `incomplete`, `draft`, `published`, `obsolete`" + + "transcript": { + "type": "array", + "title": "Transcript", + "items": { + "type": "object", + "properties": { + "language": { + "title": "Language", + "type": "string" + }, + "text": { + "title": "Text", + "type": "string" + } + } + }, + "required": [ + "text" + ] }, - "is_based_on": { - "type": "string", - "title":"A resource from which this work is derived", - "description": "A resource from which this work is derived or from which it is a modification or adaption" + + "media": { + "type": "array", + "title": "Media", + "items": { + "type": "string" + } }, - "is_part_of": { - "type": "string", - "title":"Indicate an item that this item is part of" - } + + "album": { + "type": "array", + "title": "Album", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Name of album", + "type": "string" + }, + "description": { + "title": "Description", + "type": "string" + }, + "owner": { + "title": "Owner", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + } + } + }, "required": [ @@ -346,6 +629,136 @@ "tag" ] }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", diff --git a/application/schemas/visualization-schema.json b/application/schemas/visualization-schema.json index 538f102d6..14aac2b7d 100644 --- a/application/schemas/visualization-schema.json +++ b/application/schemas/visualization-schema.json @@ -935,35 +935,7 @@ "required": [ "name" ] - }, - "provenance":{ - "type":"array", - "description":"Provenance", - "items":{ - "$ref":"provenance-schema.json" - } - }, - "tags": { - "type": "array", - "title": "Tags", - "description": "Tags", - "items": { - "type": "object", - "properties": { - "tag": { - "title": "Tag", - "type": "string" - }, - "tag_group": { - "title": "Tag group", - "type": "string" - } - } - }, - "required": [ - "tag" - ] - } + } }, "additionalProperties": false @@ -999,6 +971,164 @@ ] } }, + "provenance":{ + "type":"array", + "description":"Provenance", + "items":{ + "$ref":"provenance-schema.json" + } + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "Tags", + "items": { + "type": "object", + "properties": { + "tag": { + "title": "Tag", + "type": "string" + }, + "tag_group": { + "title": "Tag group", + "type": "string" + } + } + }, + "required": [ + "tag" + ] + }, + "lda_topics": { + "type": "array", + "title": "LDA topics", + "description": "LDA topics", + "items": { + "type": "object", + "properties": { + "model_info": { + "type": "array", + "title": "Model information", + "items": { + "type": "object", + "properties": { + "source": { + "title": "Source", + "type": "string" + }, + "author": { + "title": "Author", + "type": "string" + }, + "version": { + "title": "Version", + "type": "string" + }, + "model_id": { + "title": "Model Identifier", + "type": "string" + }, + "nb_topics": { + "title": "Number of topics", + "type": "number" + }, + "description": { + "title": "Description", + "type": "string" + }, + "corpus": { + "title": "Corpus name", + "type": "string" + }, + "uri": { + "title": "URI", + "type": "string" + } + } + }, + "required": [ + "model_id" + ] + }, + "topic_description": { + "type": "array", + "title": "Topic information", + "items": { + "type": "object", + "properties": { + "topic_id": { + "title": "Topic identifier", + "type": ["integer", "string"] + }, + "topic_score": { + "title": "Topic score", + "type": ["number", "string"] + }, + "topic_label": { + "title": "Topic label", + "type": "string" + }, + "topic_words": { + "type": "array", + "title": "Topic words", + "description": "Words", + "items": { + "type": "object", + "properties": { + "word": { + "title": "Word", + "type": "string" + }, + "word_weight": { + "title": "Word weight", + "type": "number" + } + } + }, + "required": [ + "word" + ] + } + } + }, + "required": [ + "topic_id" + ] + } + + }, + "additionalProperties": false + } + }, + "embeddings":{ + "type": "array", + "title": "Word embeddings", + "description": "Word embeddings", + "items": { + "type": "object", + "properties": { + "id": { + "title": "Vector Model ID", + "type": "string" + }, + "description": { + "title": "Vector Model Description", + "type": "string" + }, + "date": { + "title": "Date (YYYY-MM-DD)", + "type": "string" + }, + "vector": { + "title": "Vector", + "type": "object" + } + }, + "required": [ + "id","vector" + ] + } + }, "additional": { "type": "object", "description": "Additional metadata", From d5f64ca35ac6fb35776bb31940e6401e3ba58970 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Thu, 10 Mar 2022 15:37:18 -0500 Subject: [PATCH 14/79] fix line endings issue for reading nada generated DDIs in Nesstar publisher --- application/libraries/DDI_Writer.php | 11 +--- application/views/ddi/ddi25_stdy_dscr.php | 67 ++++++++++++----------- 2 files changed, 36 insertions(+), 42 deletions(-) diff --git a/application/libraries/DDI_Writer.php b/application/libraries/DDI_Writer.php index 8d314df1f..aa257c41f 100644 --- a/application/libraries/DDI_Writer.php +++ b/application/libraries/DDI_Writer.php @@ -344,16 +344,7 @@ function get_var_desc_xml($data) 'notes'=>$var['var_notes'], 'txt'=>$var['var_txt'], 'codInstr'=>$var['var_codinstr'], - 'concept'=>$var['var_concept'], - - 'varFormat'=>[ - '_value'=> (string)$var['var_format.value'], - '_attributes'=>[ - 'type'=>$var['var_format.type'], - //'schema'=>$var['var_format.schema'],//not supported - 'formatname'=>$var['var_format.name'] - ] - ] + 'concept'=>$var['var_concept'] ]); diff --git a/application/views/ddi/ddi25_stdy_dscr.php b/application/views/ddi/ddi25_stdy_dscr.php index f6227f151..0fc7df7f9 100644 --- a/application/views/ddi/ddi25_stdy_dscr.php +++ b/application/views/ddi/ddi25_stdy_dscr.php @@ -51,7 +51,7 @@ - get_el('study_desc/distribution_statement/contact');?> + get_el('study_desc/distribution_statement/contact');?> el_val($contact,'name');?> @@ -68,23 +68,23 @@ el('study_desc/series_statement/series_name');?> - el('study_desc/series_statement/series_info');?> + el('study_desc/series_statement/series_info');?>]]> el('study_desc/version_statement/version');?> el('study_desc/version_statement/version_resp');?> - el('study_desc/version_statement/version_notes');?> + el('study_desc/version_statement/version_notes');?>]]> - el('study_desc/bib_citation');?> + el('study_desc/bib_citation');?>]]> get_el('study_desc/holdings');?> el_val($holding,'name');?> - el('study_desc/study_notes');?> + el('study_desc/study_notes');?>]]> */?> - el('study_desc/study_info/study_budget');?> + el('study_desc/study_info/study_budget');?>]]> get_el('study_desc/study_info/keywords');?> @@ -120,7 +120,7 @@ - el('study_desc/study_info/abstract');?> + el('study_desc/study_info/abstract');?>]]> get_el('study_desc/study_info/time_periods');?> @@ -175,11 +175,11 @@ */ ?> - el('study_desc/study_info/analysis_unit');?> - el('study_desc/study_info/universe');?> + el('study_desc/study_info/analysis_unit');?>]]> + el('study_desc/study_info/universe');?>]]> el('study_desc/study_info/data_kind');?> - + + */?> @@ -199,9 +200,9 @@ el('study_desc/study_info/quality_statement/other_quality_statement');?> - el('study_desc/study_info/notes');?> + el('study_desc/study_info/notes');?>]]> - + --> */ ?> get_el('study_desc/study_info/ex_post_evaluation/evaluator');?> @@ -271,7 +272,7 @@ el('study_desc/method/data_collection/collector_training/training');?> el('study_desc/method/data_collection/frequency');?> - el('study_desc/method/data_collection/sampling_procedure');?> + el('study_desc/method/data_collection/sampling_procedure');?>]]> el('study_desc/method/data_collection/sample_frame/name');?> @@ -300,11 +301,13 @@ - el('study_desc/method/data_collection/research_instrument');?> + el('study_desc/method/data_collection/research_instrument');?>]]> + + */?> el('study_desc/method/data_collection/instru_development');?> */?> - el('study_desc/method/data_collection/coll_situation');?> - el('study_desc/method/data_collection/act_min');?> - el('study_desc/method/data_collection/control_operations');?> - el('study_desc/method/data_collection/weight');?> - el('study_desc/method/data_collection/cleaning_operations');?> + el('study_desc/method/data_collection/coll_situation');?>]]> + el('study_desc/method/data_collection/act_min');?>]]> + el('study_desc/method/data_collection/control_operations');?>]]> + el('study_desc/method/data_collection/weight');?>]]> + el('study_desc/method/data_collection/cleaning_operations');?>]]> - el('study_desc/method/method_notes');?> + el('study_desc/method/method_notes');?>]]> - el('study_desc/method/analysis_info/response_rate');?> - el('study_desc/method/analysis_info/sampling_error_estimates');?> - el('study_desc/method/analysis_info/data_appraisal');?> + el('study_desc/method/analysis_info/response_rate');?>]]> + el('study_desc/method/analysis_info/sampling_error_estimates');?>]]> + el('study_desc/method/analysis_info/data_appraisal');?>]]> - el('study_desc/method/study_class');?> + el('study_desc/method/study_class');?>]]> el('study_desc/method/data_processing');?> @@ -361,7 +364,7 @@ el('study_desc/data_access/dataset_availability/coll_size');?> el('study_desc/data_access/dataset_availability/complete');?> el('study_desc/data_access/dataset_availability/file_quantity');?> - el('study_desc/data_access/dataset_availability/notes');?> + el('study_desc/data_access/dataset_availability/notes');?>]]> @@ -385,12 +388,12 @@ el_val($contact,'name');?> - el('study_desc/data_access/dataset_use/cit_req');?> - el('study_desc/data_access/dataset_use/deposit_req');?> - el('study_desc/data_access/dataset_use/conditions');?> - el('study_desc/data_access/dataset_use/disclaimer');?> + el('study_desc/data_access/dataset_use/cit_req');?>]]> + el('study_desc/data_access/dataset_use/deposit_req');?>]]> + el('study_desc/data_access/dataset_use/conditions');?>]]> + el('study_desc/data_access/dataset_use/disclaimer');?>]]> - el('study_desc/data_access/notes');?> + el('study_desc/data_access/notes');?>]]> - el('study_desc/notes');?> + el('study_desc/notes');?>]]> \ No newline at end of file From 5da180dd06b3cf6e08655d46539f0b83d300556d Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Thu, 10 Mar 2022 15:41:15 -0500 Subject: [PATCH 15/79] minor --- .../catalog-admin/timeseries-db-schema.json | 18 ++++++++++++++++++ application/schemas/timeseries-db-schema.json | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/api-documentation/catalog-admin/timeseries-db-schema.json b/api-documentation/catalog-admin/timeseries-db-schema.json index 7c7636e89..83ef8a63b 100644 --- a/api-documentation/catalog-admin/timeseries-db-schema.json +++ b/api-documentation/catalog-admin/timeseries-db-schema.json @@ -386,6 +386,24 @@ ] } }, + "ref_country": { + "type": "array", + "title": "Reference country", + "description": "List of countries for which data are available", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Country name", + "type": "string" + }, + "code": { + "title": "Country code", + "type": "string" + } + } + } + }, "geographic_units": { "title": "Geographic locations", "description": "List of geographic units (regions, countries, states, provinces, etc.) for which data are available in the database.", diff --git a/application/schemas/timeseries-db-schema.json b/application/schemas/timeseries-db-schema.json index 7c7636e89..83ef8a63b 100644 --- a/application/schemas/timeseries-db-schema.json +++ b/application/schemas/timeseries-db-schema.json @@ -386,6 +386,24 @@ ] } }, + "ref_country": { + "type": "array", + "title": "Reference country", + "description": "List of countries for which data are available", + "items": { + "type": "object", + "properties": { + "name": { + "title": "Country name", + "type": "string" + }, + "code": { + "title": "Country code", + "type": "string" + } + } + } + }, "geographic_units": { "title": "Geographic locations", "description": "List of geographic units (regions, countries, states, provinces, etc.) for which data are available in the database.", From 8b3639cb903caafe5cd3cb654f221ddce8c0d6a8 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Thu, 10 Mar 2022 16:45:41 -0500 Subject: [PATCH 16/79] minor --- application/views/ddi/ddi25_stdy_dscr.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/application/views/ddi/ddi25_stdy_dscr.php b/application/views/ddi/ddi25_stdy_dscr.php index 0fc7df7f9..27baa6280 100644 --- a/application/views/ddi/ddi25_stdy_dscr.php +++ b/application/views/ddi/ddi25_stdy_dscr.php @@ -260,6 +260,7 @@ el_val($collector,'name');?> + + --> + */?> el('study_desc/method/data_collection/collector_training/training');?> el('study_desc/method/data_collection/frequency');?> From 89c57a4529d8946513f1bc4a433651c07cbf68a9 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Fri, 11 Mar 2022 12:29:35 -0500 Subject: [PATCH 17/79] Update display template for documents --- .../catalog-admin/document-schema.json | 2 +- .../language/english/fields_document_lang.php | 58 +++++++++++++++++-- application/models/Dataset_document_model.php | 2 +- application/schemas/document-schema.json | 2 +- .../metadata_templates/document-template.php | 49 ++++++++++------ 5 files changed, 88 insertions(+), 25 deletions(-) diff --git a/api-documentation/catalog-admin/document-schema.json b/api-documentation/catalog-admin/document-schema.json index 311756b1b..8f37dc225 100644 --- a/api-documentation/catalog-admin/document-schema.json +++ b/api-documentation/catalog-admin/document-schema.json @@ -1139,7 +1139,7 @@ }, "vector": { "title": "Vector", - "type": "object" + "type": ["object","array"] } }, "required": [ diff --git a/application/language/english/fields_document_lang.php b/application/language/english/fields_document_lang.php index 530100b56..30faa5600 100644 --- a/application/language/english/fields_document_lang.php +++ b/application/language/english/fields_document_lang.php @@ -23,12 +23,17 @@ $lang['metadata.metadata_information.producers.role']='Role'; $lang['metadata.metadata_information.production_date']='Date of Production'; $lang['metadata.metadata_information.version']='Document version'; + $lang['metadata.document_description']='Document Description'; -$lang['metadata.document_description.title_statement.idno']='Unique user defined ID'; +$lang['metadata.document_description.title_statement.idno']='Identifier'; $lang['metadata.document_description.title_statement.title']='Title'; $lang['metadata.document_description.title_statement.sub_title']='Subtitle'; $lang['metadata.document_description.title_statement.alternate_title']='Abbreviation or Acronym'; -$lang['metadata.document_description.title_statement.abbreviated_title']='Abbreviated Title'; +$lang['metadata.document_description.title_statement.translated_title']='Translated Title'; +$lang['metadata.document_description.identifiers']='Identifiers'; +$lang['metadata.document_description.identifiers.type']='Type'; +$lang['metadata.document_description.identifiers.identifier']='Identifier'; + $lang['metadata.document_description.type']='Resource type'; $lang['metadata.document_description.status']='Status'; $lang['metadata.document_description.description']='Description'; @@ -41,6 +46,13 @@ $lang['metadata.document_description.notes']='Notes'; $lang['metadata.document_description.notes.note']='Note'; $lang['metadata.document_description.scope']='Scope'; + +$lang['metadata.document_description.geographic_units']='Geographic units'; +$lang['metadata.document_description.geographic_units.name']='Name'; +$lang['metadata.document_description.geographic_units.code']='Code'; +$lang['metadata.document_description.geographic_units.type']='Type'; + + $lang['metadata.document_description.ref_country']='Reference country'; $lang['metadata.document_description.ref_country.name']='Country name'; $lang['metadata.document_description.ref_country.code']='Country code'; @@ -66,6 +78,7 @@ $lang['metadata.document_description.institution']='Institution'; $lang['metadata.document_description.journal']='Journal name'; $lang['metadata.document_description.volume']='Volume number'; +$lang['metadata.document_description.number']='Number'; $lang['metadata.document_description.issue']='Issue number'; $lang['metadata.document_description.pages']='Page numbers'; $lang['metadata.document_description.series']='Series name'; @@ -75,6 +88,8 @@ $lang['metadata.document_description.authors.initial']='Initial'; $lang['metadata.document_description.authors.last_name']='Last name'; $lang['metadata.document_description.authors.affiliation']='Affiliation'; +$lang['metadata.document_description.authors.author_id']='ID'; +$lang['metadata.document_description.authors.full_name']='Full name'; $lang['metadata.document_description.editors']='Editors'; $lang['metadata.document_description.editors.first_name']='First name'; $lang['metadata.document_description.editors.initial']='Initial'; @@ -90,8 +105,27 @@ $lang['metadata.document_description.contributors.initial']='Initial'; $lang['metadata.document_description.contributors.last_name']='Last name'; $lang['metadata.document_description.contributors.affiliation']='Affiliation'; +$lang['metadata.document_description.contributors.role']='Role'; +$lang['metadata.document_description.contributors.contribution']='Contribution'; + +$lang['metadata.document_description.contacts']='Contacts'; +$lang['metadata.document_description.contacts.name']='Name'; +$lang['metadata.document_description.contacts.role']='Role'; +$lang['metadata.document_description.contacts.affiliation']='Affiliation'; +$lang['metadata.document_description.contacts.email']='Email'; +$lang['metadata.document_description.contacts.telephone']='Telephone'; +$lang['metadata.document_description.contacts.uri']='uri'; + $lang['metadata.document_description.publisher']='Publisher'; $lang['metadata.document_description.publisher_address']='Publisher\'s address'; +$lang['metadata.document_description.annote']='Annote'; +$lang['metadata.document_description.booktitle']='Book title'; +$lang['metadata.document_description.crossref']='Cross reference'; +$lang['metadata.document_description.howpublished']='Published'; +$lang['metadata.document_description.key']='Key'; +$lang['metadata.document_description.organization']='Organization'; +$lang['metadata.document_description.url']='URI'; +$lang['metadata.document_description.disclaimer']='Disclaimer'; $lang['metadata.document_description.rights']='Rights'; $lang['metadata.document_description.copyright']='Copyright'; $lang['metadata.document_description.usage_terms']='Terms governing use and reproduction'; @@ -102,22 +136,30 @@ $lang['metadata.document_description.sources.source_origin']='Origin of Source'; $lang['metadata.document_description.sources.source_char']='Characteristics of Source Noted'; $lang['metadata.document_description.sources.source_doc']='Source documentation'; + +$lang['metadata.document_description.data_sources']='Data sources'; +$lang['metadata.document_description.data_sources.name']='Name'; +$lang['metadata.document_description.data_sources.uri']='URI'; +$lang['metadata.document_description.data_sources.note']='Note'; + $lang['metadata.document_description.keywords']='Keywords'; $lang['metadata.document_description.keywords.name']='Name'; $lang['metadata.document_description.keywords.vocabulary']='Vocabulary name'; $lang['metadata.document_description.keywords.uri']='Vocabulary URI'; $lang['metadata.document_description.themes']='Themes'; +$lang['metadata.document_description.themes.id']='Identifier'; $lang['metadata.document_description.themes.name']='Name'; $lang['metadata.document_description.themes.vocabulary']='Vocabulary name'; $lang['metadata.document_description.themes.uri']='Vocabulary URI'; $lang['metadata.document_description.topics']='Topics'; -$lang['metadata.document_description.topics.id']='Unique Identifier'; +$lang['metadata.document_description.topics.id']='Identifier'; $lang['metadata.document_description.topics.name']='Topic'; $lang['metadata.document_description.topics.parent_id']='Parent topic Identifier'; $lang['metadata.document_description.topics.vocabulary']='Vocabulary'; $lang['metadata.document_description.topics.uri']='Vocabulary URI'; $lang['metadata.document_description.disciplines']='Disciplines'; -$lang['metadata.document_description.disciplines.name']='Discipline title or name'; +$lang['metadata.document_description.disciplines.id']='Identifier'; +$lang['metadata.document_description.disciplines.name']='Name'; $lang['metadata.document_description.disciplines.vocabulary']='Vocabulary'; $lang['metadata.document_description.disciplines.uri']='URI'; $lang['metadata.document_description.audience']='Audience'; @@ -135,6 +177,7 @@ $lang['metadata.document_description.lda_topics']='LDA topics'; $lang['metadata.document_description.lda_topics.model_info']='Model information'; $lang['metadata.document_description.lda_topics.model_info.source']='Source'; +$lang['lda_model.source']='Source'; $lang['lda_model.author']='Author'; $lang['lda_model.version']='Version'; $lang['lda_model.model_id']='Model Identifier'; @@ -163,3 +206,10 @@ $lang['metadata.tags']='Tags'; $lang['metadata.tags.tag']='Tag'; + + +$lang['metadata.embeddings']='Embeddings'; +$lang['metadata.embeddings.id']='ID'; +$lang['metadata.embeddings.description']='Description'; +$lang['metadata.embeddings.date']='Date'; +$lang['metadata.embeddings.vector']='Vector'; \ No newline at end of file diff --git a/application/models/Dataset_document_model.php b/application/models/Dataset_document_model.php index e2178793d..062db6400 100644 --- a/application/models/Dataset_document_model.php +++ b/application/models/Dataset_document_model.php @@ -78,7 +78,7 @@ function create_dataset($type,$options, $sid=null) $options['changed']=date("U"); //fields to be stored as metadata - $study_metadata_sections=array('metadata_information','document_description','files','resources','tags','additional'); + $study_metadata_sections=array('metadata_information','document_description','files','resources','provenance','embeddings','lda_topics','tags','additional'); //external resources $external_resources=$this->get_array_nested_value($options,'resources'); diff --git a/application/schemas/document-schema.json b/application/schemas/document-schema.json index 311756b1b..8f37dc225 100644 --- a/application/schemas/document-schema.json +++ b/application/schemas/document-schema.json @@ -1139,7 +1139,7 @@ }, "vector": { "title": "Vector", - "type": "object" + "type": ["object","array"] } }, "required": [ diff --git a/application/views/metadata_templates/document-template.php b/application/views/metadata_templates/document-template.php index e48d2f2fb..5ba73c86a 100644 --- a/application/views/metadata_templates/document-template.php +++ b/application/views/metadata_templates/document-template.php @@ -24,6 +24,7 @@ $fields=array( "metadata.document_description.title_statement.idno"=>"text", "metadata.document_description.title_statement.title"=>"text", + "metadata.document_description.identifiers"=>"array", "metadata.resources"=>'resources', @@ -32,7 +33,11 @@ "metadata.document_description.title_statement.sub_title"=>"text", "metadata.document_description.title_statement.alternate_title"=>"text", - "metadata.document_description.title_statement.abbreviated_title"=>"text", + "metadata.document_description.title_statement.translated_title"=>"text", + + + + "metadata.document_description.type"=>"text", "metadata.document_description.status"=>"text", "metadata.document_description.description"=>"text", @@ -42,6 +47,8 @@ "metadata.document_description.notes"=>"array", "metadata.document_description.scope"=>"text", "metadata.document_description.ref_country"=>"array", + "metadata.document_description.geographic_units"=>"array", + "metadata.document_description.bbox"=>"bounding_box", "metadata.document_description.spatial_coverage"=>"text", "metadata.document_description.temporal_coverage"=>"text", "metadata.document_description.date_created"=>"text", @@ -61,8 +68,8 @@ "metadata.document_description.institution"=>"text", "metadata.document_description.volume"=>"text", - "metadata.document_description.issue"=>"text", - "metadata.document_description.pages"=>"text" + "metadata.document_description.number"=>"text", + "metadata.document_description.pages"=>"text" ), $metadata); ?> @@ -83,8 +90,16 @@ "metadata.document_description.editors"=>"array", "metadata.document_description.translators"=>"array", "metadata.document_description.contributors"=>"array", + "metadata.document_description.contacts"=>"array", "metadata.document_description.publisher"=>"text", - "metadata.document_description.publisher_address"=>"text" + "metadata.document_description.publisher_address"=>"text", + "metadata.document_description.annote"=>"text", + "metadata.document_description.booktitle"=>"text", + "metadata.document_description.crossref"=>"text", + "metadata.document_description.howpublished"=>"text", + "metadata.document_description.key"=>"text", + "metadata.document_description.organization"=>"text", + "metadata.document_description.url"=>"text" ), $metadata); ?> @@ -103,6 +118,7 @@ "metadata.document_description.rights"=>"text", "metadata.document_description.copyright"=>"text", "metadata.document_description.usage_terms"=>"text", + "metadata.document_description.disclaimer"=>"text", "metadata.document_description.security_classification"=>"text", "metadata.document_description.access_restrictions"=>"text" ), @@ -111,15 +127,9 @@ "array", - "metadata.document_description.keywords"=>"", - "metadata.document_description.keywords.name"=>"text", - "metadata.document_description.keywords.vocabulary"=>"text", - "metadata.document_description.keywords.uri"=>"text", - "metadata.document_description.themes"=>"", - "metadata.document_description.themes.name"=>"text", - "metadata.document_description.themes.vocabulary"=>"text", - "metadata.document_description.themes.uri"=>"text", + "metadata.document_description.sources"=>"array", + "metadata.document_description.data_sources"=>"array", + "metadata.document_description.themes"=>"array", "metadata.document_description.topics"=>"array", "metadata.document_description.disciplines"=>"array", "metadata.document_description.audience"=>"text", @@ -133,10 +143,12 @@ "lda_topics", - "metadata.document_description.lda_topics.model_info"=>"array", - "metadata.document_description.lda_topics.topic_description"=>"array", - "metadata.document_description.lda_topics.topic_description.topic_words.word"=>"text", + "metadata.lda_topics"=>"lda_topics", + "metadata.lda_topics.model_info"=>"array", + "metadata.lda_topics.topic_description"=>"array", + "metadata.lda_topics.topic_description.topic_words.word"=>"text", + "metadata.embeddings"=>"array", + "metadata.additional"=>"dump", ), $metadata); ?> @@ -149,7 +161,8 @@ "metadata.metadata_information.title"=>"text", "metadata.metadata_information.idno"=>"text", "metadata.metadata_information.producers"=>"array", - "metadata.metadata_information.version"=>"text", + "metadata.metadata_information.production_date"=>"text", + "metadata.metadata_information.version"=>"text", ), $metadata); ?> From 8cddf0d46ac815be70adedc99f091449f350131e Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Wed, 16 Mar 2022 15:45:34 -0400 Subject: [PATCH 18/79] update document display page + add subtitle field --- application/helpers/metadata_view_helper.php | 22 ++- .../libraries/Catalog_search_mysql.php | 4 +- application/models/Dataset_document_model.php | 1 + application/models/Dataset_model.php | 31 +++ .../metadata_templates/document-template.php | 181 ++++++++++-------- .../metadata_templates/fields/field_dump.php | 4 +- .../fields/field_lda_model.php | 32 ++++ .../fields/field_lda_topics.php | 2 +- application/views/search/layout.php | 3 + application/views/search/surveys.php | 5 +- application/views/survey_info/info.php | 44 ++++- application/views/survey_info/layout.php | 5 + install/schema.mysql.sql | 1 + install/schema.sqlsrv.sql | 1 + 14 files changed, 236 insertions(+), 100 deletions(-) create mode 100644 application/views/metadata_templates/fields/field_lda_model.php diff --git a/application/helpers/metadata_view_helper.php b/application/helpers/metadata_view_helper.php index dc1db5eac..37b590ac9 100644 --- a/application/helpers/metadata_view_helper.php +++ b/application/helpers/metadata_view_helper.php @@ -227,5 +227,23 @@ function get_string_value($data,$type='text') throw new Exception("TYPE_NOT_SUPPORTED: ".$type); } -/* End of file search_helper.php */ -/* Location: ./application/helpers/search_helper.php */ \ No newline at end of file + +if ( ! function_exists('authors_to_string')) +{ + function authors_to_string($authors=array()) + { + $output=array(); + foreach($authors as $author){ + $author_name=array( + isset($author['first_name']) ? $author['first_name'] : '', + isset($author['last_name']) ? $author['last_name']: '' + ); + $output[]=implode(" ", array_filter($author_name)); + } + + return implode(", ", $output); + } +} + +/* End of file metadata_view_helper.php */ +/* Location: ./application/helpers/metadata_view_helper.php */ \ No newline at end of file diff --git a/application/libraries/Catalog_search_mysql.php b/application/libraries/Catalog_search_mysql.php index e6c91f07a..7b4020f25 100644 --- a/application/libraries/Catalog_search_mysql.php +++ b/application/libraries/Catalog_search_mysql.php @@ -190,7 +190,7 @@ public function search($limit=15, $offset=0) } //study fields returned by the select statement - $study_fields='surveys.id as id, surveys.type, surveys.idno as idno,surveys.title,nation,authoring_entity'; + $study_fields='surveys.id as id, surveys.type, surveys.idno as idno,surveys.title,surveys.subtitle,nation,authoring_entity'; $study_fields.=',forms.model as form_model, data_class_id, surveys.year_start,surveys.year_end, surveys.thumbnail'; $study_fields.=',surveys.repositoryid as repositoryid, link_da, repositories.title as repo_title, surveys.created,surveys.changed,surveys.total_views,surveys.total_downloads,varcount'; @@ -373,7 +373,7 @@ public function search_counts_by_type() } //study fields returned by the select statement - $study_fields='surveys.id as id, surveys.type, surveys.idno as idno,surveys.title,nation,authoring_entity,forms.model as form_model,data_class_id,surveys.year_start,surveys.year_end'; + $study_fields='surveys.id as id, surveys.type, surveys.idno as idno,surveys.title,surveys.subtitle,nation,authoring_entity,forms.model as form_model,data_class_id,surveys.year_start,surveys.year_end'; $study_fields.=', surveys.repositoryid as repositoryid, link_da, repositories.title as repo_title, surveys.created,surveys.changed,surveys.total_views,surveys.total_downloads'; //build final search sql query diff --git a/application/models/Dataset_document_model.php b/application/models/Dataset_document_model.php index 062db6400..d52e249dd 100644 --- a/application/models/Dataset_document_model.php +++ b/application/models/Dataset_document_model.php @@ -140,6 +140,7 @@ function get_core_fields($options) { $output=array(); $output['title']=$this->get_array_nested_value($options,'document_description/title_statement/title'); + $output['subtitle']=$this->get_array_nested_value($options,'document_description/title_statement/sub_title'); $output['idno']=$this->get_array_nested_value($options,'document_description/title_statement/idno'); $nations=(array)$this->get_array_nested_value($options,'document_description/ref_country'); diff --git a/application/models/Dataset_model.php b/application/models/Dataset_model.php index 6f44eb65a..497c0867f 100644 --- a/application/models/Dataset_model.php +++ b/application/models/Dataset_model.php @@ -20,6 +20,7 @@ class Dataset_model extends CI_Model { 'repositoryid', 'idno', 'title', + 'subtitle', 'abbreviation', 'authoring_entity', 'nation', @@ -1850,5 +1851,35 @@ function get_country_names_string($nations) return $nation_str; } + + function update_locations($sid, $bounds=array()) + { + var_dump($bounds); + + //delete any existing locations + $this->db->delete('survey_locations',array('sid' => $sid)); + + if(!is_array($bounds)){ + return false; + } + + foreach($bounds as $bbox) + { + $north=$bbox['north']; + $south=$bbox['south']; + $east=$bbox['east']; + $west=$bbox['west']; + + $this->load->helper("gis_helper"); + $bbox_wkt=$this->db->escape(bbox_to_wkt($north, $south, $east, $west)); + + $this->db->set('sid',$sid); + $this->db->set('location','ST_GeomFromText('.$bbox_wkt.')',false); + $this->db->insert('survey_locations'); + + echo $this->db->last_query(); + } + } + }//end-class diff --git a/application/views/metadata_templates/document-template.php b/application/views/metadata_templates/document-template.php index 5ba73c86a..c96a214f0 100644 --- a/application/views/metadata_templates/document-template.php +++ b/application/views/metadata_templates/document-template.php @@ -12,6 +12,13 @@ **/ ?> + + + "text", "metadata.document_description.title_statement.title"=>"text", - "metadata.document_description.identifiers"=>"array", - - "metadata.resources"=>'resources', - - "metadata.document_description.journal"=>"text", - "metadata.document_description.date_published"=>"text", - "metadata.document_description.title_statement.sub_title"=>"text", "metadata.document_description.title_statement.alternate_title"=>"text", "metadata.document_description.title_statement.translated_title"=>"text", - - - "metadata.document_description.type"=>"text", - "metadata.document_description.status"=>"text", - "metadata.document_description.description"=>"text", - "metadata.document_description.toc"=>"text", - "metadata.document_description.toc_structured"=>"array", - "metadata.document_description.abstract"=>"text", - "metadata.document_description.notes"=>"array", - "metadata.document_description.scope"=>"text", - "metadata.document_description.ref_country"=>"array", - "metadata.document_description.geographic_units"=>"array", - "metadata.document_description.bbox"=>"bounding_box", - "metadata.document_description.spatial_coverage"=>"text", - "metadata.document_description.temporal_coverage"=>"text", "metadata.document_description.date_created"=>"text", "metadata.document_description.date_available"=>"text", + "metadata.document_description.date_published"=>"text", "metadata.document_description.date_modified"=>"text", - - - //"metadata.document_description.id_numbers"=>"object", - "metadata.document_description.id_numbers.type"=>"text", - "metadata.document_description.id_numbers.value"=>"text", + + + "metadata.document_description.authors"=>"array", + "metadata.document_description.editors"=>"array", + "metadata.document_description.type"=>"text", "metadata.document_description.publication_frequency"=>"text", + "metadata.document_description.series"=>"text", + "metadata.document_description.status"=>"text", + "metadata.document_description.abstract"=>"text", + "metadata.document_description.description"=>"text", + + "metadata.document_description.audience"=>"text", + "metadata.document_description.mandate"=>"text", + + "metadata.document_description.title_statement.idno"=>"text", + "metadata.document_description.identifiers"=>"array", + "metadata.document_description.languages"=>"array", - "metadata.document_description.license"=>"array", - "metadata.document_description.bibliographic_citation"=>"text", - "metadata.document_description.chapter"=>"text", - "metadata.document_description.edition"=>"text", - "metadata.document_description.institution"=>"text", - "metadata.document_description.volume"=>"text", - "metadata.document_description.number"=>"text", - "metadata.document_description.pages"=>"text" + "metadata.resources"=>'resources', ), $metadata); ?> -"text", + "metadata.document_description.scope"=>"text", + "metadata.document_description.ref_country"=>"array", + "metadata.document_description.geographic_units"=>"array", + "metadata.document_description.bbox"=>"bounding_box", + "metadata.document_description.spatial_coverage"=>"text", + "metadata.document_description.temporal_coverage"=>"text", + "metadata.document_description.toc"=>"text", + "metadata.document_description.toc_structured"=>"array", + + "metadata.document_description.keywords"=>"array", + "metadata.tags"=>"array_comma", + "metadata.document_description.topics"=>"array", + "metadata.document_description.themes"=>"array", + "metadata.document_description.disciplines"=>"array", + ), $metadata); ?> - "lda_topics", + "metadata.lda_topics.model_info"=>"array", + "metadata.lda_topics.topic_description"=>"array", + "metadata.lda_topics.topic_description.topic_words.word"=>"text", + "metadata.embeddings"=>"array", + "metadata.additional"=>"dump", + ), + $metadata); +?> + + "text", - "metadata.document_description.authors"=>"array", - "metadata.document_description.editors"=>"array", + "metadata.document_description.creator"=>"text", "metadata.document_description.translators"=>"array", "metadata.document_description.contributors"=>"array", - "metadata.document_description.contacts"=>"array", - "metadata.document_description.publisher"=>"text", - "metadata.document_description.publisher_address"=>"text", - "metadata.document_description.annote"=>"text", - "metadata.document_description.booktitle"=>"text", - "metadata.document_description.crossref"=>"text", - "metadata.document_description.howpublished"=>"text", - "metadata.document_description.key"=>"text", - "metadata.document_description.organization"=>"text", - "metadata.document_description.url"=>"text" + "metadata.document_description.contacts"=>"array" ), $metadata); ?> + +"text", + "metadata.document_description.chapter"=>"text", + "metadata.document_description.edition"=>"text", + "metadata.document_description.institution"=>"text", + "metadata.document_description.journal"=>"text", + "metadata.document_description.volume"=>"text", + "metadata.document_description.number"=>"text", + "metadata.document_description.pages"=>"text", + "metadata.document_description.publisher"=>"text", + "metadata.document_description.publisher_address"=>"text", + "metadata.document_description.annote"=>"text", + "metadata.document_description.booktitle"=>"text", + "metadata.document_description.crossref"=>"text", + "metadata.document_description.howpublished"=>"text", + "metadata.document_description.key"=>"text", + "metadata.document_description.organization"=>"text", + "metadata.document_description.url"=>"text" + ), + $metadata); +?> + "text", - "metadata.document_description.reproducibility.links"=>"array", + "metadata.document_description.reproducibility.statement"=>"text", + "metadata.document_description.sources"=>"array", + "metadata.document_description.data_sources"=>"array", + "metadata.document_description.relations"=>"array", ), $metadata); - ?> +?> "array", + "metadata.document_description.disclaimer"=>"text", "metadata.document_description.rights"=>"text", "metadata.document_description.copyright"=>"text", "metadata.document_description.usage_terms"=>"text", - "metadata.document_description.disclaimer"=>"text", + "metadata.document_description.security_classification"=>"text", - "metadata.document_description.access_restrictions"=>"text" + "metadata.document_description.access_restrictions"=>"text", + "metadata.document_description.pricing"=>"text", + "metadata.document_description.reproducibility.links"=>"array", ), $metadata); ?> - "array", - "metadata.document_description.data_sources"=>"array", - "metadata.document_description.themes"=>"array", - "metadata.document_description.topics"=>"array", - "metadata.document_description.disciplines"=>"array", - "metadata.document_description.audience"=>"text", - "metadata.document_description.mandate"=>"text", - "metadata.document_description.pricing"=>"text", - "metadata.document_description.relations"=>"array", - "metadata.tags"=>"array_comma", - ), - $metadata); + "array", + ), + $metadata); ?> -"lda_topics", - "metadata.lda_topics.model_info"=>"array", - "metadata.lda_topics.topic_description"=>"array", - "metadata.lda_topics.topic_description.topic_words.word"=>"text", - "metadata.embeddings"=>"array", - "metadata.additional"=>"dump", - ), - $metadata); -?> + diff --git a/application/views/metadata_templates/fields/field_dump.php b/application/views/metadata_templates/fields/field_dump.php index 90bc965c0..ddfe31423 100644 --- a/application/views/metadata_templates/fields/field_dump.php +++ b/application/views/metadata_templates/fields/field_dump.php @@ -1,3 +1,5 @@ +
 
-
\ No newline at end of file + + \ No newline at end of file diff --git a/application/views/metadata_templates/fields/field_lda_model.php b/application/views/metadata_templates/fields/field_lda_model.php new file mode 100644 index 000000000..d74aa6259 --- /dev/null +++ b/application/views/metadata_templates/fields/field_lda_model.php @@ -0,0 +1,32 @@ + + +
+
+
+ + + + +
+ + +
+ +
+ + + + +
+
+ diff --git a/application/views/metadata_templates/fields/field_lda_topics.php b/application/views/metadata_templates/fields/field_lda_topics.php index 2fe357585..e9c97789e 100644 --- a/application/views/metadata_templates/fields/field_lda_topics.php +++ b/application/views/metadata_templates/fields/field_lda_topics.php @@ -12,7 +12,7 @@ - + diff --git a/application/views/search/layout.php b/application/views/search/layout.php index 8647efaf3..fe556c5c6 100644 --- a/application/views/search/layout.php +++ b/application/views/search/layout.php @@ -7,6 +7,9 @@ margin-bottom:10px; font-weight:bold; } +.study-subtitle{ + font-size:small; +}
diff --git a/application/views/search/surveys.php b/application/views/search/surveys.php index c5e6222dd..54d52aa09 100644 --- a/application/views/search/surveys.php +++ b/application/views/search/surveys.php @@ -190,7 +190,10 @@ - + + +
+
diff --git a/application/views/survey_info/info.php b/application/views/survey_info/info.php index 2f5037f31..2eb5f43f2 100644 --- a/application/views/survey_info/info.php +++ b/application/views/survey_info/info.php @@ -1,18 +1,24 @@ '.$survey['nation'].''; - } + + $sub_title=array(); + + if ($survey['type']=='document' && isset($survey['metadata']['document_description']['authors'])){ + $sub_title[]= ''.authors_to_string($survey['metadata']['document_description']['authors']).''; + }else{ + if ($survey['nation']!=''){ + $sub_title[]=''.$survey['nation'].''; + } + } $dates=array_unique(array($survey['year_start'],$survey['year_end'])); - $dates=implode(" - ", $dates); + $dates=implode(" - ", $dates); if(!empty($dates)){ - $sub_title[]=''.$dates.''; - } + $sub_title[]=''.$dates.''; + } + $sub_title=implode(", ", $sub_title); ?> -
-

+

+ + +
+ +

@@ -76,7 +87,7 @@ class="get-microdata-btn badge badge-primary wb-text-link-uppercase float-left m
- +
@@ -88,6 +99,19 @@ class="get-microdata-btn badge badge-primary wb-text-link-uppercase float-left m
+ + +
+
+ +
+
+
+ +
+
+
+ 0): ?>
diff --git a/application/views/survey_info/layout.php b/application/views/survey_info/layout.php index cf6138d77..8b992f063 100644 --- a/application/views/survey_info/layout.php +++ b/application/views/survey_info/layout.php @@ -14,6 +14,11 @@ font-size: 14px; } +.study-subtitle{ + font-size:.7em; + margin-bottom:10px; +} + .badge-outline{ background:transparent; color:#03a9f4; diff --git a/install/schema.mysql.sql b/install/schema.mysql.sql index 801a1fb1d..0faa349ee 100644 --- a/install/schema.mysql.sql +++ b/install/schema.mysql.sql @@ -346,6 +346,7 @@ CREATE TABLE `surveys` ( `type` varchar(15) DEFAULT NULL, `repositoryid` varchar(100) DEFAULT NULL, `title` varchar(255) NOT NULL DEFAULT '', + `subtitle` varchar(255) DEFAULT NULL, `abbreviation` varchar(45) DEFAULT NULL, `authoring_entity` text, `nation` varchar(150) DEFAULT '', diff --git a/install/schema.sqlsrv.sql b/install/schema.sqlsrv.sql index 33232c835..b2b928cb7 100644 --- a/install/schema.sqlsrv.sql +++ b/install/schema.sqlsrv.sql @@ -337,6 +337,7 @@ CREATE TABLE surveys ( type varchar(15) DEFAULT NULL, repositoryid varchar(128) NOT NULL, title varchar(255) DEFAULT '', + subtitle varchar(255) DEFAULT '', abbreviation varchar(45) DEFAULT NULL, authoring_entity varchar(max) DEFAULT NULL, nation varchar(150) DEFAULT '', From 48e00070c45d79c2409c2fe6df20aa7cda5cb315 Mon Sep 17 00:00:00 2001 From: Mehmood Asghar Date: Thu, 17 Mar 2022 10:35:38 -0400 Subject: [PATCH 19/79] Minor fixes for display for related datasets/studies --- application/controllers/admin/Attach_related_data.php | 2 +- application/views/catalog/select_related_studies.php | 10 ++-------- application/views/survey_info/related_studies.php | 10 +++++++--- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/application/controllers/admin/Attach_related_data.php b/application/controllers/admin/Attach_related_data.php index 688e56a9d..ab2576cd9 100644 --- a/application/controllers/admin/Attach_related_data.php +++ b/application/controllers/admin/Attach_related_data.php @@ -131,7 +131,7 @@ private function _search($skey){ //set pagination options - $base_url = site_url('admin/dialog_select_studies/index/'.$skey); + $base_url = site_url('admin/catalog/attach_related_data/'.$skey); $config['base_url'] = $base_url; $config['total_rows'] = $total; $config['per_page'] = $limit; diff --git a/application/views/catalog/select_related_studies.php b/application/views/catalog/select_related_studies.php index ccb9edbc9..29c851f9a 100644 --- a/application/views/catalog/select_related_studies.php +++ b/application/views/catalog/select_related_studies.php @@ -54,13 +54,7 @@