From 4be510f24ccdd6a06567c1d21a2c79421a7c7244 Mon Sep 17 00:00:00 2001 From: Ayoola Bimpe C Date: Mon, 9 May 2022 14:19:39 -0300 Subject: [PATCH 01/21] fixed #36 --- docs/DataScience.md | 2 +- docs/standard_desc/ActionResearch.js | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) delete mode 100644 docs/standard_desc/ActionResearch.js diff --git a/docs/DataScience.md b/docs/DataScience.md index 1590926..fe12442 100644 --- a/docs/DataScience.md +++ b/docs/DataScience.md @@ -1,7 +1,7 @@ # Data Science -Studies that analyze software engineering phenomena or artifacts using data-centric analysis methods such as machine learning or other computational intelligence appraches as well as search-based approaches[1](#myfootnote1) +Studies that analyze software engineering phenomena or artifacts using data-centric analysis methods such as machine learning or other computational intelligence appraches as well as search-based approaches[1](#myfootnote1) ## Application diff --git a/docs/standard_desc/ActionResearch.js b/docs/standard_desc/ActionResearch.js deleted file mode 100644 index 2748c10..0000000 --- a/docs/standard_desc/ActionResearch.js +++ /dev/null @@ -1,2 +0,0 @@ -alert('Empirical research that investigates how an intervention, like the ' + - 'introduction of a method or tool, affects a real-life context') \ No newline at end of file From a1232166ee9407301fcd63a65cf56d706a733a97 Mon Sep 17 00:00:00 2001 From: Ayoola Bimpe C Date: Tue, 10 May 2022 15:01:06 -0300 Subject: [PATCH 02/21] fixed #36 --- docs/DataScience.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DataScience.md b/docs/DataScience.md index fe12442..778ecb7 100644 --- a/docs/DataScience.md +++ b/docs/DataScience.md @@ -1,7 +1,7 @@ # Data Science -Studies that analyze software engineering phenomena or artifacts using data-centric analysis methods such as machine learning or other computational intelligence appraches as well as search-based approaches[1](#myfootnote1) +Studies that analyze software engineering phenomena or artifacts using data-centric analysis methods such as machine learning or other computational intelligence appraches as well as search-based approaches[1](#myfootnote1) ## Application From 8ef6e41bbb07954b8808e6c668763d90cf68fba1 Mon Sep 17 00:00:00 2001 From: Ayoola Bimpe C Date: Tue, 10 May 2022 15:06:08 -0300 Subject: [PATCH 03/21] fixed #36 --- docs/DataScience.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DataScience.md b/docs/DataScience.md index 778ecb7..9c3a6c0 100644 --- a/docs/DataScience.md +++ b/docs/DataScience.md @@ -1,7 +1,7 @@ # Data Science -Studies that analyze software engineering phenomena or artifacts using data-centric analysis methods such as machine learning or other computational intelligence appraches as well as search-based approaches[1](#myfootnote1) +Studies that analyze software engineering phenomena or artifacts using data-centric analysis methods such as machine learning or other computational intelligence appraches as well as search-based approaches[1](#myfootnote1) ## Application From 138970b16d887c06bc7ca426fc2cb6eac405554d Mon Sep 17 00:00:00 2001 From: Ayoola Bimpe C Date: Sun, 15 May 2022 23:52:53 -0300 Subject: [PATCH 04/21] testing.. --- docs/CaseStudy.md | 6 ++++++ form_generator/js/read_standards.js | 7 ++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/CaseStudy.md b/docs/CaseStudy.md index 72aa4cc..81697fb 100644 --- a/docs/CaseStudy.md +++ b/docs/CaseStudy.md @@ -59,6 +59,12 @@ captures a large quantitative dataset with limited context, consider the + +### Supplementary Material + +- [ ] provides supplemental materials such as interview guide(s), coding schemes, coding examples, decision rules, or extended chain-of-evidence tables +- [ ] triangulates across data sources, informants or researchers + ### Desirable Attributes diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index d5f9e5e..8cecfa8 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -989,6 +989,9 @@ function create_requirements_checklist(){ // create Header for Essential Requirements with an unordered list var EssentialUL = create_requirements_heading_with_UL("Essential"); + // create Header for Supplementary Requirements with an unordered list + var SupplementaryUL = create_requirements_heading_with_UL("Supplementary Materials"); + // create Header for Desirable Requirements with an unordered list var DesirableUL = create_requirements_heading_with_UL("Desirable"); @@ -998,12 +1001,14 @@ function create_requirements_checklist(){ // hide desirable and extraordinary list of requirements for One Phase Reviewer if(role == "\"one-phase-reviewer\""){ DesirableUL.style = "padding: 0px; display:none;"; + SupplementaryUL.style = "padding: 0px; display:none;"; ExtraordinaryUL.style = "padding: 0px; display:none;"; } // hide desirable and extraordinary list of requirements for Two Phase Reviewer else if(role == "\"two-phase-reviewer\""){ DesirableUL.style = "padding: 0px; display:none;"; - ExtraordinaryUL.style = "padding: 0px; display:none;"; + SupplementaryUL.style = "padding: 0px; display:none;"; + ExtraordinaryUL.style = "padding: 0px; display:none;"; } // unshift() method adds new items to the beginning of an array, and returns the new length From b3f5b94aab3d73cbfa875979b0779af0fb3f6c36 Mon Sep 17 00:00:00 2001 From: Ayoola Bimpe C Date: Mon, 16 May 2022 09:32:28 -0300 Subject: [PATCH 05/21] Fixed Supplementary Materials testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. testing.. updated supplementary materials --- docs/CaseStudy.md | 17 +++++++---- form_generator/js/read_standards.js | 46 ++++++++++++++++++++++------- tab_03_standards.md | 2 +- 3 files changed, 47 insertions(+), 18 deletions(-) diff --git a/docs/CaseStudy.md b/docs/CaseStudy.md index 81697fb..4898d19 100644 --- a/docs/CaseStudy.md +++ b/docs/CaseStudy.md @@ -48,6 +48,14 @@ captures a large quantitative dataset with limited context, consider the - [ ] reports the type of case study[1](#myfootnote1) - [ ] describes data sources (e.g. participants' demographics and work roles) - [ ] defines unit(s) of analysis or observation +- [ ] coding scheme (required) +- [ ] coding examples (required) +- [ ] extended chain-of-evidence table(s) (required) + + + + + @@ -60,16 +68,13 @@ captures a large quantitative dataset with limited context, consider the -### Supplementary Material - -- [ ] provides supplemental materials such as interview guide(s), coding schemes, coding examples, decision rules, or extended chain-of-evidence tables -- [ ] triangulates across data sources, informants or researchers - - + ### Desirable Attributes - [ ] provides supplemental materials such as interview guide(s), coding schemes, coding examples, decision rules, or extended chain-of-evidence tables +- [ ] interview guide(s) (optional) +- [ ] decision rules (optional) - [ ] triangulates across data sources, informants or researchers - [ ] cross-checks interviewee statements (e.g. against direct observation or archival records) - [ ] uses participant observation (ethnography) or direct observation (non-ethnography) and clearly integrates these observations into results[2](#myfootnote2) diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index 8cecfa8..0c3eaf1 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -144,6 +144,7 @@ function generate_decision_message_block() { } else if (justification_type2_checked_count > 0) { msg = "GATEKEEP"; document.getElementById("deviation_reasonable").style.display = "block"; + document.getElementById("Supplementary Materials").style.display = "block"; document.getElementById("Desirable").style.display = "block"; document.getElementById("Extraordinary").style.display = "block"; @@ -151,11 +152,13 @@ function generate_decision_message_block() { } else if (justification_type1_checked_count > 0) { msg = "ACCEPT"; document.getElementById("deviation_reasonable").style.display = "block"; + document.getElementById("Supplementary Materials").style.display = "block"; document.getElementById("Desirable").style.display = "block"; document.getElementById("Extraordinary").style.display = "block"; } else { msg = "ACCEPT"; + document.getElementById("Supplementary Materials").style.display = "block"; document.getElementById("Desirable").style.display = "block"; document.getElementById("Extraordinary").style.display = "block"; @@ -679,8 +682,9 @@ function generate_two_phase_reviewer_deviation_block(checklistItem_id) { return deviation_block; } + // convert from Markdown to HTML checklists -function convert_MD_standard_checklists_to_html_standard_checklists(standardName, checklistName, checklistText, footnotes){ +function convert_MD_standard_checklists_to_html_standard_checklists(standardName, checklistName, checklistText, footnotes,supCheckList){ // ??????? tester = getParameterByName('y')[0] == 'noval' ? true : false; @@ -735,13 +739,19 @@ function convert_MD_standard_checklists_to_html_standard_checklists(standardName // !!!!!!!!!!!!!!!! we dont need this part in the checklist if(line_text.includes("complies with all applicable empirical standards")) continue; - + // if line_text includes a specific regex set to true ( line break with horizontal rule) IMRaD_line_break = line_text.includes('_hr_') ? true : false; // Replace line break and horizontal rule with empty string line_text = line_text.replace(/(_hr_)+/g, ''); + //comment later + if(line_text.includes("{supplement}") && checklistName !== "Supplementary") { + supCheckList.items += "- [ ]" + line_text; + continue; + } + // Change the text to the string held in line_text checklistItemLI.setAttribute("text", line_text); @@ -816,6 +826,7 @@ function convert_MD_standard_checklists_to_html_standard_checklists(standardName checklists.appendChild(checklistItemLI); } } + return checklists; } @@ -902,10 +913,10 @@ function create_role_heading(){ } // Prepare unordered lists -function preparation_to_convert_MD_to_HTML(standardTagName, checklistTagName, checklistInnerHTML, footnotes){ +function preparation_to_convert_MD_to_HTML(standardTagName, checklistTagName, checklistInnerHTML, footnotes,supCheckList){ // superscript tags - checklistInnerHTML = checklistInnerHTML.replaceAll("", "{sup}").replaceAll("", "{/sup}"); + checklistInnerHTML = checklistInnerHTML.replaceAll("", "{sup}").replaceAll("", "{/sup}").replaceAll("", "{supplement}"); var tempDivElement = document.createElement("div"); tempDivElement.innerHTML = checklistInnerHTML; @@ -922,8 +933,9 @@ function preparation_to_convert_MD_to_HTML(standardTagName, checklistTagName, ch // Supplement Files - Change from docs to link, change from .md file to nothing checklistText = checklistText.replaceAll('https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=').replaceAll('.md', ''); + // Convert Markdown Checklists to HTML checklists - checklists = convert_MD_standard_checklists_to_html_standard_checklists(standardTagName, checklistTagName, checklistText, footnotes) + checklists = convert_MD_standard_checklists_to_html_standard_checklists(standardTagName, checklistTagName, checklistText, footnotes,supCheckList) return checklists; } @@ -986,6 +998,8 @@ function create_requirements_checklist(){ form.id = "checklists"; form.name = "checklists"; + var supCheckList = {items:""}; + // create Header for Essential Requirements with an unordered list var EssentialUL = create_requirements_heading_with_UL("Essential"); @@ -1001,13 +1015,13 @@ function create_requirements_checklist(){ // hide desirable and extraordinary list of requirements for One Phase Reviewer if(role == "\"one-phase-reviewer\""){ DesirableUL.style = "padding: 0px; display:none;"; - SupplementaryUL.style = "padding: 0px; display:none;"; + SupplementaryUL.style = "padding: 0px; display:block;"; ExtraordinaryUL.style = "padding: 0px; display:none;"; } // hide desirable and extraordinary list of requirements for Two Phase Reviewer else if(role == "\"two-phase-reviewer\""){ DesirableUL.style = "padding: 0px; display:none;"; - SupplementaryUL.style = "padding: 0px; display:none;"; + SupplementaryUL.style = "padding: 0px; display:block;"; ExtraordinaryUL.style = "padding: 0px; display:none;"; } @@ -1065,18 +1079,20 @@ function create_requirements_checklist(){ EssentialUL.appendChild(Yes_No); //EssentialUL.appendChild(checklists); } + else if (checklistTag.getAttribute('name') == "Desirable") { //DesirableUL.appendChild(standard_header_rule); // Change from Markdown to HTML elements - checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes); + checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); DesirableUL.appendChild(checklists); } + else if (checklistTag.getAttribute('name') == "Extraordinary") { //ExtraordinaryUL.appendChild(standard_header_rule); // Change from Markdown to HTML elements - checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes); + checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); ExtraordinaryUL.appendChild(checklists); } } @@ -1089,15 +1105,22 @@ function create_requirements_checklist(){ notify_testers(); // Change from Markdown to HTML elements - checklists = preparation_to_convert_MD_to_HTML("", 'Essential', all_essential_IMRaD_items_innerHTML, footnotes); + checklists = preparation_to_convert_MD_to_HTML("", 'Essential', all_essential_IMRaD_items_innerHTML, footnotes,supCheckList); EssentialUL.appendChild(checklists); - + + checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), "Supplementary", supCheckList.items.replaceAll("{supplement}", ""), footnotes,supCheckList); + SupplementaryUL.appendChild(checklists); + + // Add Essential Attributes to the form form.appendChild(EssentialUL); // Create download button var download = create_download_button(); + //append supplementary material list + form.appendChild(SupplementaryUL); + // (All 'Yes' -> accept manuscript) var decision_msg = generate_message("decision_msg", "red", (role != "\"author\"" ? "The manuscript meets all essential criteria: ACCEPT." : ""), 2, 0); form.appendChild(decision_msg); @@ -1131,6 +1154,7 @@ function create_requirements_checklist(){ } // Add Desirable and Extraordinary Unordered List to Form + form.appendChild(DesirableUL); form.appendChild(ExtraordinaryUL); diff --git a/tab_03_standards.md b/tab_03_standards.md index bb24378..f4be2e3 100644 --- a/tab_03_standards.md +++ b/tab_03_standards.md @@ -105,7 +105,7 @@ function openStandardFromURL(evt) {

{% capture std %}{% include_relative docs/CaseStudy.md %}{% endcapture %} - {{ std | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | replace: '- [ ]', '-' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/', '../docs?standard=' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=' | replace: '.md', '' | markdownify }} + {{ std | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | replace: '- [ ]', '-' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/', '../docs?standard=' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=' | replace: '.md', '' | markdownify }}

From 9582e4679d173b4dd975d9185524a7e95b617e56 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Sat, 28 May 2022 14:23:14 -0300 Subject: [PATCH 06/21] updated supplementary materials --- form_generator/js/read_standards.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index 0c3eaf1..bb1408e 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -1015,13 +1015,13 @@ function create_requirements_checklist(){ // hide desirable and extraordinary list of requirements for One Phase Reviewer if(role == "\"one-phase-reviewer\""){ DesirableUL.style = "padding: 0px; display:none;"; - SupplementaryUL.style = "padding: 0px; display:block;"; + SupplementaryUL.style = "padding: 0px; display:none;"; ExtraordinaryUL.style = "padding: 0px; display:none;"; } // hide desirable and extraordinary list of requirements for Two Phase Reviewer else if(role == "\"two-phase-reviewer\""){ DesirableUL.style = "padding: 0px; display:none;"; - SupplementaryUL.style = "padding: 0px; display:block;"; + SupplementaryUL.style = "padding: 0px; display:none;"; ExtraordinaryUL.style = "padding: 0px; display:none;"; } From 48a7aafe6c2f3435ca6989eade706313b90713a8 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Sat, 28 May 2022 14:50:20 -0300 Subject: [PATCH 07/21] updated supplementary materials --- form_generator/js/read_standards.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index bb1408e..6b53179 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -125,6 +125,7 @@ function generate_decision_message_block() { document.getElementById("deviation_reasonable").style.display = "none"; document.getElementById("deviation_unreasonable").style.display = "none"; + document.getElementById("Supplementary Materials").style.display = "block"; document.getElementById("Desirable").style.display = "none"; document.getElementById("Extraordinary").style.display = "none"; // checkboxInput.className = "checkbox_attributes"; @@ -182,6 +183,7 @@ function generate_decision_message_block() { document.getElementById("deviation_reasonable").style.display = "none"; document.getElementById("deviation_unreasonable").style.display = "none"; + document.getElementById("Supplementary Materials").style.display = "block"; document.getElementById("Desirable").style.display = "none"; document.getElementById("Extraordinary").style.display = "none"; $('.checkbox_attributes').prop('checked', false); @@ -1015,13 +1017,13 @@ function create_requirements_checklist(){ // hide desirable and extraordinary list of requirements for One Phase Reviewer if(role == "\"one-phase-reviewer\""){ DesirableUL.style = "padding: 0px; display:none;"; - SupplementaryUL.style = "padding: 0px; display:none;"; + SupplementaryUL.style = "padding: 0px; display:block;"; ExtraordinaryUL.style = "padding: 0px; display:none;"; } // hide desirable and extraordinary list of requirements for Two Phase Reviewer else if(role == "\"two-phase-reviewer\""){ DesirableUL.style = "padding: 0px; display:none;"; - SupplementaryUL.style = "padding: 0px; display:none;"; + SupplementaryUL.style = "padding: 0px; display:block;"; ExtraordinaryUL.style = "padding: 0px; display:none;"; } From ec8ce2f182229172422fa6a73816e7f0c4b73e00 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 10:53:00 -0300 Subject: [PATCH 08/21] fixing supplementary material heading in case study --- docs/CaseStudy.md | 11 +++++++++++ form_generator/js/read_standards.js | 17 +++++++++++++++-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/CaseStudy.md b/docs/CaseStudy.md index 4898d19..1333bc5 100644 --- a/docs/CaseStudy.md +++ b/docs/CaseStudy.md @@ -69,6 +69,17 @@ captures a large quantitative dataset with limited context, consider the + +### Supplementary Materials + +- [ ] coding scheme (required) +- [ ] coding examples (required) +- [ ] extended chain-of-evidence table(s) (required) +- [ ] interview guide(s) (optional) +- [ ] decision rules (optional) + + + ### Desirable Attributes diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index 6b53179..4d516a1 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -749,7 +749,12 @@ function convert_MD_standard_checklists_to_html_standard_checklists(standardName line_text = line_text.replace(/(_hr_)+/g, ''); //comment later - if(line_text.includes("{supplement}") && checklistName !== "Supplementary") { + // if(line_text.includes("{supplement}") && checklistName !== "Supplementary") { + // supCheckList.items += "- [ ]" + line_text; + // continue; + // } + + if(line_text.includes("{supplement}")) { supCheckList.items += "- [ ]" + line_text; continue; } @@ -1090,6 +1095,14 @@ function create_requirements_checklist(){ DesirableUL.appendChild(checklists); } + else if (checklistTag.getAttribute('name') == "Supplementary") { + //DesirableUL.appendChild(standard_header_rule); + + // Change from Markdown to HTML elements + checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); + DesirableUL.appendChild(checklists); + } + else if (checklistTag.getAttribute('name') == "Extraordinary") { //ExtraordinaryUL.appendChild(standard_header_rule); @@ -1101,7 +1114,7 @@ function create_requirements_checklist(){ } all_essential_IMRaD_items_innerHTML = "" + all_intro_items + "\n_hr_" + all_method_items + "\n_hr_" + all_results_items + "\n_hr_" + all_discussion_items + "\n_hr_" + all_other_items all_essential_IMRaD_items_innerHTML = all_essential_IMRaD_items_innerHTML.replaceAll("\n_hr_", "").length > 0 ? all_essential_IMRaD_items_innerHTML : ""; - + // Notify testers in the case of unrecognized tags, no tags at all, or untagged attributes notify_testers(); From 2f9dc7e0bb1528b5fefd7085bb16c7d624909089 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 10:59:39 -0300 Subject: [PATCH 09/21] fixing supplementary material heading in case study --- docs/CaseStudy.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/CaseStudy.md b/docs/CaseStudy.md index 1333bc5..03b6246 100644 --- a/docs/CaseStudy.md +++ b/docs/CaseStudy.md @@ -48,9 +48,7 @@ captures a large quantitative dataset with limited context, consider the - [ ] reports the type of case study[1](#myfootnote1) - [ ] describes data sources (e.g. participants' demographics and work roles) - [ ] defines unit(s) of analysis or observation -- [ ] coding scheme (required) -- [ ] coding examples (required) -- [ ] extended chain-of-evidence table(s) (required) + @@ -72,20 +70,24 @@ captures a large quantitative dataset with limited context, consider the ### Supplementary Materials -- [ ] coding scheme (required) -- [ ] coding examples (required) -- [ ] extended chain-of-evidence table(s) (required) -- [ ] interview guide(s) (optional) -- [ ] decision rules (optional) + +- [ ] coding scheme (required) +- [ ] coding examples (required) +- [ ] extended chain-of-evidence table(s) (required) +- [ ] interview guide(s) (optional) +- [ ] decision rules (optional) + + + + + ### Desirable Attributes - [ ] provides supplemental materials such as interview guide(s), coding schemes, coding examples, decision rules, or extended chain-of-evidence tables -- [ ] interview guide(s) (optional) -- [ ] decision rules (optional) - [ ] triangulates across data sources, informants or researchers - [ ] cross-checks interviewee statements (e.g. against direct observation or archival records) - [ ] uses participant observation (ethnography) or direct observation (non-ethnography) and clearly integrates these observations into results[2](#myfootnote2) From af3f1c525ae29ab3dfc69d80dd0edfffaa58e942 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 11:13:44 -0300 Subject: [PATCH 10/21] fixing supplementary material heading in case study --- docs/CaseStudy.md | 12 +++++------- form_generator/js/read_standards.js | 7 ++++--- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/CaseStudy.md b/docs/CaseStudy.md index 03b6246..5866d90 100644 --- a/docs/CaseStudy.md +++ b/docs/CaseStudy.md @@ -71,19 +71,17 @@ captures a large quantitative dataset with limited context, consider the ### Supplementary Materials -- [ ] coding scheme (required) -- [ ] coding examples (required) -- [ ] extended chain-of-evidence table(s) (required) -- [ ] interview guide(s) (optional) -- [ ] decision rules (optional) +- [ ] coding scheme (required) +- [ ] coding examples (required) +- [ ] extended chain-of-evidence table(s) (required) +- [ ] interview guide(s) (optional) +- [ ] decision rules (optional) - - ### Desirable Attributes diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index 4d516a1..bda762f 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -1087,7 +1087,7 @@ function create_requirements_checklist(){ //EssentialUL.appendChild(checklists); } - else if (checklistTag.getAttribute('name') == "Desirable") { + else if (checklistTag.getAttribute('name') == "Supplementary") { //DesirableUL.appendChild(standard_header_rule); // Change from Markdown to HTML elements @@ -1095,14 +1095,15 @@ function create_requirements_checklist(){ DesirableUL.appendChild(checklists); } - else if (checklistTag.getAttribute('name') == "Supplementary") { + else if (checklistTag.getAttribute('name') == "Desirable") { //DesirableUL.appendChild(standard_header_rule); // Change from Markdown to HTML elements checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); - DesirableUL.appendChild(checklists); + //SupplementaryUL.appendChild(checklists); } + else if (checklistTag.getAttribute('name') == "Extraordinary") { //ExtraordinaryUL.appendChild(standard_header_rule); From d28db504ea212061d0e309f322dbb4cacc18b19a Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 11:29:51 -0300 Subject: [PATCH 11/21] fixing supplementary material heading in case study --- docs/CaseStudy.md | 14 +++++--------- form_generator/js/read_standards.js | 4 ++-- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/CaseStudy.md b/docs/CaseStudy.md index 5866d90..1db0258 100644 --- a/docs/CaseStudy.md +++ b/docs/CaseStudy.md @@ -70,18 +70,14 @@ captures a large quantitative dataset with limited context, consider the ### Supplementary Materials - -- [ ] coding scheme (required) -- [ ] coding examples (required) -- [ ] extended chain-of-evidence table(s) (required) -- [ ] interview guide(s) (optional) -- [ ] decision rules (optional) +- [ ] coding scheme (required) +- [ ] coding examples (required) +- [ ] extended chain-of-evidence table(s) (required) +- [ ] interview guide(s) (optional) +- [ ] decision rules (optional) - - - ### Desirable Attributes diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index bda762f..1b3218a 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -1092,7 +1092,7 @@ function create_requirements_checklist(){ // Change from Markdown to HTML elements checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); - DesirableUL.appendChild(checklists); + //DesirableUL.appendChild(checklists); } else if (checklistTag.getAttribute('name') == "Desirable") { @@ -1100,7 +1100,7 @@ function create_requirements_checklist(){ // Change from Markdown to HTML elements checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); - //SupplementaryUL.appendChild(checklists); + SupplementaryUL.appendChild(checklists); } From 52455eda0796735e91b88e57a9bdd257dd8b3fa5 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 11:35:33 -0300 Subject: [PATCH 12/21] fixing supplementary material heading in case study --- tab_03_standards.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tab_03_standards.md b/tab_03_standards.md index f4be2e3..119364c 100644 --- a/tab_03_standards.md +++ b/tab_03_standards.md @@ -105,7 +105,7 @@ function openStandardFromURL(evt) {

{% capture std %}{% include_relative docs/CaseStudy.md %}{% endcapture %} - {{ std | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | replace: '- [ ]', '-' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/', '../docs?standard=' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=' | replace: '.md', '' | markdownify }} + {{ std | remove: '' | remove: '' | remove: '' | remove: '' |remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | replace: '- [ ]', '-' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/', '../docs?standard=' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=' | replace: '.md', '' | markdownify }}

From cd776c6490c78bd98aecd0a22b7a5555bb369673 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 11:40:47 -0300 Subject: [PATCH 13/21] fixing supplementary material heading in case study --- form_generator/js/read_standards.js | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index 1b3218a..686eb6e 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -1087,13 +1087,13 @@ function create_requirements_checklist(){ //EssentialUL.appendChild(checklists); } - else if (checklistTag.getAttribute('name') == "Supplementary") { - //DesirableUL.appendChild(standard_header_rule); - - // Change from Markdown to HTML elements - checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); - //DesirableUL.appendChild(checklists); - } + // else if (checklistTag.getAttribute('name') == "Supplementary") { + // //DesirableUL.appendChild(standard_header_rule); + // + // // Change from Markdown to HTML elements + // checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); + // //DesirableUL.appendChild(checklists); + // } else if (checklistTag.getAttribute('name') == "Desirable") { //DesirableUL.appendChild(standard_header_rule); From eca964106a71828eefa92ded28d699c3615e8d98 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 11:56:17 -0300 Subject: [PATCH 14/21] fixing supplementary material heading in case study --- form_generator/js/read_standards.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index 686eb6e..317cdaf 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -749,16 +749,16 @@ function convert_MD_standard_checklists_to_html_standard_checklists(standardName line_text = line_text.replace(/(_hr_)+/g, ''); //comment later - // if(line_text.includes("{supplement}") && checklistName !== "Supplementary") { - // supCheckList.items += "- [ ]" + line_text; - // continue; - // } - - if(line_text.includes("{supplement}")) { + if(line_text.includes("{supplement}") && checklistName !== "Supplementary") { supCheckList.items += "- [ ]" + line_text; continue; } + // if(line_text.includes("{supplement}")) { + // supCheckList.items += "- [ ]" + line_text; + // continue; + // } + // Change the text to the string held in line_text checklistItemLI.setAttribute("text", line_text); From 489a80125be427536727d07a7dbada74b2e5bcb1 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 11:59:24 -0300 Subject: [PATCH 15/21] fixing supplementary material heading in case study --- form_generator/js/read_standards.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index 317cdaf..c8a8371 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -1100,7 +1100,7 @@ function create_requirements_checklist(){ // Change from Markdown to HTML elements checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); - SupplementaryUL.appendChild(checklists); + DesirableUL.appendChild(checklists); } From f69d29ccec69a5fa45e4f22f8b2a82e8736186ee Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 12:03:50 -0300 Subject: [PATCH 16/21] fixing supplementary material heading in case study --- form_generator/js/read_standards.js | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index c8a8371..d9164ef 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -749,7 +749,7 @@ function convert_MD_standard_checklists_to_html_standard_checklists(standardName line_text = line_text.replace(/(_hr_)+/g, ''); //comment later - if(line_text.includes("{supplement}") && checklistName !== "Supplementary") { + if(line_text.includes("{supplement}") && checklistName === "Supplementary") { supCheckList.items += "- [ ]" + line_text; continue; } @@ -1087,13 +1087,13 @@ function create_requirements_checklist(){ //EssentialUL.appendChild(checklists); } - // else if (checklistTag.getAttribute('name') == "Supplementary") { - // //DesirableUL.appendChild(standard_header_rule); - // - // // Change from Markdown to HTML elements - // checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); - // //DesirableUL.appendChild(checklists); - // } + else if (checklistTag.getAttribute('name') == "Supplementary") { + //DesirableUL.appendChild(standard_header_rule); + + // Change from Markdown to HTML elements + checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); + SupplementaryUL.appendChild(checklists); + } else if (checklistTag.getAttribute('name') == "Desirable") { //DesirableUL.appendChild(standard_header_rule); From 6822d34f01c398ff1b591ae1688735718bf9bfec Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Mon, 30 May 2022 10:53:00 -0300 Subject: [PATCH 17/21] case study.md - fixed supplementary materials heading fixing supplementary material heading in case study fixing supplementary material heading in case study fixing supplementary material heading in case study fixing supplementary material heading in case study fixing supplementary material heading in case study fixing supplementary material heading in case study fixing supplementary material heading in case study fixing supplementary material heading in case study --- docs/CaseStudy.md | 17 ++++++++++++----- form_generator/js/read_standards.js | 18 ++++++++++++++++-- tab_03_standards.md | 2 +- 3 files changed, 29 insertions(+), 8 deletions(-) diff --git a/docs/CaseStudy.md b/docs/CaseStudy.md index 4898d19..1db0258 100644 --- a/docs/CaseStudy.md +++ b/docs/CaseStudy.md @@ -48,9 +48,7 @@ captures a large quantitative dataset with limited context, consider the - [ ] reports the type of case study[1](#myfootnote1) - [ ] describes data sources (e.g. participants' demographics and work roles) - [ ] defines unit(s) of analysis or observation -- [ ] coding scheme (required) -- [ ] coding examples (required) -- [ ] extended chain-of-evidence table(s) (required) + @@ -69,12 +67,21 @@ captures a large quantitative dataset with limited context, consider the + +### Supplementary Materials + +- [ ] coding scheme (required) +- [ ] coding examples (required) +- [ ] extended chain-of-evidence table(s) (required) +- [ ] interview guide(s) (optional) +- [ ] decision rules (optional) + + + ### Desirable Attributes - [ ] provides supplemental materials such as interview guide(s), coding schemes, coding examples, decision rules, or extended chain-of-evidence tables -- [ ] interview guide(s) (optional) -- [ ] decision rules (optional) - [ ] triangulates across data sources, informants or researchers - [ ] cross-checks interviewee statements (e.g. against direct observation or archival records) - [ ] uses participant observation (ethnography) or direct observation (non-ethnography) and clearly integrates these observations into results[2](#myfootnote2) diff --git a/form_generator/js/read_standards.js b/form_generator/js/read_standards.js index 6b53179..d9164ef 100644 --- a/form_generator/js/read_standards.js +++ b/form_generator/js/read_standards.js @@ -749,11 +749,16 @@ function convert_MD_standard_checklists_to_html_standard_checklists(standardName line_text = line_text.replace(/(_hr_)+/g, ''); //comment later - if(line_text.includes("{supplement}") && checklistName !== "Supplementary") { + if(line_text.includes("{supplement}") && checklistName === "Supplementary") { supCheckList.items += "- [ ]" + line_text; continue; } + // if(line_text.includes("{supplement}")) { + // supCheckList.items += "- [ ]" + line_text; + // continue; + // } + // Change the text to the string held in line_text checklistItemLI.setAttribute("text", line_text); @@ -1082,6 +1087,14 @@ function create_requirements_checklist(){ //EssentialUL.appendChild(checklists); } + else if (checklistTag.getAttribute('name') == "Supplementary") { + //DesirableUL.appendChild(standard_header_rule); + + // Change from Markdown to HTML elements + checklists = preparation_to_convert_MD_to_HTML(standardTag.getAttribute('name'), checklistTag.getAttribute('name'), checklistHTML, footnotes,supCheckList); + SupplementaryUL.appendChild(checklists); + } + else if (checklistTag.getAttribute('name') == "Desirable") { //DesirableUL.appendChild(standard_header_rule); @@ -1090,6 +1103,7 @@ function create_requirements_checklist(){ DesirableUL.appendChild(checklists); } + else if (checklistTag.getAttribute('name') == "Extraordinary") { //ExtraordinaryUL.appendChild(standard_header_rule); @@ -1101,7 +1115,7 @@ function create_requirements_checklist(){ } all_essential_IMRaD_items_innerHTML = "" + all_intro_items + "\n_hr_" + all_method_items + "\n_hr_" + all_results_items + "\n_hr_" + all_discussion_items + "\n_hr_" + all_other_items all_essential_IMRaD_items_innerHTML = all_essential_IMRaD_items_innerHTML.replaceAll("\n_hr_", "").length > 0 ? all_essential_IMRaD_items_innerHTML : ""; - + // Notify testers in the case of unrecognized tags, no tags at all, or untagged attributes notify_testers(); diff --git a/tab_03_standards.md b/tab_03_standards.md index f4be2e3..119364c 100644 --- a/tab_03_standards.md +++ b/tab_03_standards.md @@ -105,7 +105,7 @@ function openStandardFromURL(evt) {

{% capture std %}{% include_relative docs/CaseStudy.md %}{% endcapture %} - {{ std | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | replace: '- [ ]', '-' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/', '../docs?standard=' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=' | replace: '.md', '' | markdownify }} + {{ std | remove: '' | remove: '' | remove: '' | remove: '' |remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | remove: '' | replace: '- [ ]', '-' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/docs/', '../docs?standard=' | replace: 'https://github.com/acmsigsoft/EmpiricalStandards/blob/master/Supplements/', '../Supplements?supplement=' | replace: '.md', '' | markdownify }}

From aea80077dbfa79260ccc68cd6cf0384a2556c59b Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Tue, 21 Jun 2022 15:39:27 -0300 Subject: [PATCH 18/21] removed s from reviews and surveys --- tab_03_standards.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tab_03_standards.md b/tab_03_standards.md index 119364c..f8cc3de 100644 --- a/tab_03_standards.md +++ b/tab_03_standards.md @@ -74,11 +74,11 @@ function openStandardFromURL(evt) { - + - + - +

From efafce72f601bf657ef7556f688a69081389f29a Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Tue, 12 Jul 2022 11:23:31 -0300 Subject: [PATCH 19/21] updated footer --- _config.yml | 5 +++++ _team/contributors.md | 2 ++ index.md | 1 + 3 files changed, 8 insertions(+) diff --git a/_config.yml b/_config.yml index 853fe6f..0433b9d 100644 --- a/_config.yml +++ b/_config.yml @@ -12,3 +12,8 @@ header_pages: collections: team: output: true + +repos: + - name: Sponsor the Empirical Standards on GitHub + description: + url: https://github.com/sponsors/drpaulralph diff --git a/_team/contributors.md b/_team/contributors.md index 99fb5bb..3199f8c 100644 --- a/_team/contributors.md +++ b/_team/contributors.md @@ -110,3 +110,5 @@ **Erin Schultz**, Dalhousie University, Canada +**Bimpe Ayoola**, Dalhousie University, Canada + diff --git a/index.md b/index.md index 774416e..5ffcdf7 100644 --- a/index.md +++ b/index.md @@ -6,4 +6,5 @@ layout: default + From 48770f59d156ded221645c55dca06b79e6432d94 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Tue, 12 Jul 2022 12:22:33 -0300 Subject: [PATCH 20/21] updated footer --- _config.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/_config.yml b/_config.yml index 0433b9d..4a92d68 100644 --- a/_config.yml +++ b/_config.yml @@ -13,7 +13,6 @@ collections: team: output: true -repos: - - name: Sponsor the Empirical Standards on GitHub - description: - url: https://github.com/sponsors/drpaulralph +social-network-links: + name: Sponsor the Empirical Standards on GitHub + url: "https://github.com/sponsors/drpaulralph" \ No newline at end of file From 9c750a04092cd087413ff5071c042bfbd1ef3517 Mon Sep 17 00:00:00 2001 From: Adebimpe Ayoola Date: Fri, 15 Jul 2022 13:55:46 -0300 Subject: [PATCH 21/21] added footer.html for footer update --- _config.yml | 6 +++--- _includes/footer.html | 45 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 3 deletions(-) create mode 100644 _includes/footer.html diff --git a/_config.yml b/_config.yml index 4a92d68..1b16ad2 100644 --- a/_config.yml +++ b/_config.yml @@ -13,6 +13,6 @@ collections: team: output: true -social-network-links: - name: Sponsor the Empirical Standards on GitHub - url: "https://github.com/sponsors/drpaulralph" \ No newline at end of file +link: + label: Sponsor the Empirical Standards on GitHub + href: https://github.com/sponsors/drpaulralph \ No newline at end of file diff --git a/_includes/footer.html b/_includes/footer.html new file mode 100644 index 0000000..38f1200 --- /dev/null +++ b/_includes/footer.html @@ -0,0 +1,45 @@ + \ No newline at end of file