Nested Knowledge

Bringing Systematic Review to Life

User Tools

Site Tools


wiki:autolit:tagging:configure

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wiki:autolit:tagging:configure [2023/08/22 00:39]
kevinkallmes [5. Hide Tags]
wiki:autolit:tagging:configure [2024/01/18 11:09] (current)
jthurnham
Line 5: Line 5:
 To configure a hierarchy for your nest, follow the steps below. Once you have built the hierarchy, you can move on to [[:wiki:autolit:tagging:tag|tagging records]] you have included in your nest. To configure a hierarchy for your nest, follow the steps below. Once you have built the hierarchy, you can move on to [[:wiki:autolit:tagging:tag|tagging records]] you have included in your nest.
  
-----+Before Tag Hierarchy configuration, consider the mode you would like to use. By default, your nest has **Form-based Tagging** mode on, allowing you to configure questions and answers to be extracted in a form.  
 + 
 +Alternatively, you can switch to **Standard** mode, which is less structured and allows you to configure concepts to be extracted via a list of dropdown tags. Follow [[wiki:autolit:tagging:configurestandardtags|these instructions on configuring tags in Standard Tagging mode.]] Note: switching between modes results in no loss of data. 
 + 
 +===== Understanding Tags in the Hierarchy ===== 
 + 
 +Root Tags are the highest level of the hierarchy, and have no parent tags.  
 + 
 +Parent tags are any tags that have child tags. In the below example, "Outcomes" is a root tag (the highest level) and a parent tag to "Clinical Outcomes," "Clinical Outcomes" is a parent tag to "Mortality" (but not a root tag), and "Mortality" is a child tag (but not a parent or root tag).  
 + 
 +That said, don't worry too much about the jargon, these ontologies are simply supposed to represent the most general categories at the top, and most specific at the bottom. 
 + 
 +{{ :undefined:screenshot_2023-12-06_at_19.56.45.png?nolink |}} 
 + 
 +===== Configure Study Tags as Questions & Answers =====
  
-===== Configuring Study Tags: ===== 
  
-==== 1. Navigate to Configure Study Tags ====+==== 1. Navigate to Configure Tags ====
  
 Click on the gears icon in the Tagging tab: Click on the gears icon in the Tagging tab:
Line 19: Line 32:
 ---- ----
  
-==== 2. Create Root Tags ====+==== 2. Configure Tag Questions ====
  
-Root Tags are the highest level of the hierarchy, and have no parent tagsThese should represent the most general categories of qualitative evidence you are gathering. For example, you could create Root Tags representing the patient population, intervention, comparison group, and outcomes (PICO) or similar, and add in any other concepts of interest (such as Study Design).+To draft Questions, you need to build out the Tags in your Tagging HierarchyYou should keep in mind what tags will be Questions and which will be answers.
  
-To create a new Root Tag, click "Create New Tag":+To start, click "Create New Tag" and give the tag a name. Select a question type from the dropdown depending on the question type. 
  
-{{ :wiki:autolit:tagging:tag1.png?nolink |}}+{{ :undefined:screenshot_2023-12-06_at_19.28.32.png?nolink |}}
  
-Then, name the tag, but leave the "Parent Tag" drop-down blank. Optionally, add a Description to give details to your team on what a tag represents.+You have the following options for Question types:
  
-{{ :wiki:autolit:tagging:tag2.png?nolink |}}+  * **Single Select:**  All child tags will be shown as an option where only a single answer can be selected, 
 +  * **Multi-Select:**  All child tags will be shown as an option where multiple answers can be selected, or 
 +  * **Single Apply:**  Open-ended question type where only a text box is shown, answering the question applies the tag, indicating the concept is present.
  
-You are now ready to build your hierarchy downward from your Root Tags. Tags should get more specific as they proceed down the hierarchy.+Generally, it is best to add a full/descriptive question (such as, if you had a tag called Study Type, type out the question "What was the study type of the article?" in the Question box).
  
-----+{{ :undefined:screenshot_2023-12-06_at_19.29.33.png?nolink |}}
  
-==== 3Create Child Tags ====+Note: Leaving "Parent Tag" blank, keeps the tag at the top of the hierarchy (root tag).
  
-You can build your hierarchy downward by adding tags below the Root TagsClick "Create New Tag" and then name your Tag. __Connect it to a Root Tag by selecting the relevant tag from the dropdown list under Parent Tag.__ For example, you could nest "Age" as a tag under Patient Population, or "Mortality" under Outcomes, or even nest Outcomes → Adverse Events → Mortality to capture intermediate categories.+==== 3Configure Tag Answers ====
  
-Once you have added a child tag, your hierarchy should contain the Root Tag and the tag you created below it. Continue building out child tags until your hierarchy contains a tag for every concept you want to recognize from underlying studies and structure into your Qualitative Synthesis.+Single Apply questions do not require tag answers but for Single Select and Multiple Select Questionsthey require tag answers to work.
  
-----+Follow the same process as above via Create New Tag, input the answer as the Tag Name, leave the question type blank, add a description if applicable, click the Parent Tag dropdown and select the tag the answer belongs under.  
 + 
 +{{ :undefined:screenshot_2023-12-06_at_19.37.27.png?nolink |}} 
 + 
 +==== Example Questions of each type ==== 
 + 
 +Example Single Select question:  
 +  * **Tag Name:** Study Type 
 +  * **Question:** What was the Study Type? 
 +  * **Answers (child tags):** Randomized Controlled Trial, Prospective Cohort Study, Retrospective Study 
 + 
 +Example Multi-Select question: 
 +  * **Tag Name:** Comorbidities 
 +  * **Question:** What comorbidities were reported in the patient population? 
 +  * **Answers (child tags):** Diabetes, Hypertension, Chronic Kidney Disease 
 + 
 +Example Single Apply question: 
 +  * **Tag Name:** Study Objective 
 +  * **Question:** What was the study objective reported? 
 +  * **Answer** (not child tags, the answer will be reflected by the tag text): Tag Text/Excerpt from the underlying study. Absence of an answer means the Tag is not present in the study. 
 + 
 +{{ :undefined:screenshot_2023-12-06_at_20.00.07.png?nolink |}} 
 + 
 +===== Tips on Preliminary Hierarchy Organization =====
  
-==== Recommendations in Hierarchy Building ====+Every Question that you create will be presented to users [[:wiki:autolit:tagging:tag|during the Tagging stage]], in order of (in the hierarchy) left to right. See [[wiki:autolit:tagging:configure#reorder_tags|instructions below on reordering tags.]]
  
-To see examples of hierarchies and Qualitative Syntheses after Tagging is complete, create and examine a [[:wiki:start:demo|Demo Nest]]. If you are looking for Best Practices recommendations on what to include in your hierarchy, see [[:wiki:guide:research:tag|here]]!+In addition, due to the flexibility of tagsit can be helpful to create root and parent tags to organize your configured questions.  
  
 ---- ----
  
 ===== Import a Tag Hierarchy Template ===== ===== Import a Tag Hierarchy Template =====
 +
 +When creating a hierarchy from scratch it can be helpful to use a template. You can either import one of our public templates or a pre-built template that belongs to your organization. 
  
 ==== 1. Click "Import Hierarchy" ==== ==== 1. Click "Import Hierarchy" ====
Line 55: Line 95:
 From the Configure Tagging page, select "Import Hierarchy" From the Configure Tagging page, select "Import Hierarchy"
  
-{{ :wiki:autolit:tagging:tag3.png?nolink |}}+{{ :undefined:screenshot_2023-12-06_at_19.42.53.png?nolink |}}
  
 ==== 2. Choose a Tag Hierarchy Template ==== ==== 2. Choose a Tag Hierarchy Template ====
  
-{{ :wiki:autolit:tagging:tag4.png?nolink |}}+When importing a tag hierarchy, you have the option to import:
  
-Select the Template of interest from the list on the left side of the modal. If no Templates are listed, you may need to [[:wiki:autolit:admin:settings:orgs#giving_an_organization_ownership_of_a_nest|grant Organizational Ownership]] to give that nest access to your Organization's Templates.+  - From your organization's configured templates 
 +  - From Nested Knowledge's public templates 
 + 
 +Learn more on how to import tag templates [[wiki:autolit:tagging:importhierarchy|here.]]
  
 === How to build a Tag Hierarchy Template === === How to build a Tag Hierarchy Template ===
Line 69: Line 112:
 ==== 3. Import a Hierarchy or Root Tag ==== ==== 3. Import a Hierarchy or Root Tag ====
  
-Then, decide if you want to import the entire hierarchy (red box) or only one Root Tag and its children. To select only one Root Tag and its children, select the Root Tag and then click "Import from Root Tag."+Then, decide if you want to import the entire hierarchy or only one Root Tag and its children. For the whole hierarchy click "Import." 
 + 
 +{{ :undefined:screenshot_2023-12-06_at_19.45.19.png?nolink |}} 
 + 
 +To select only one Root Tag and its children, select the Root Tag and then click "Import from Root Tag." 
 + 
 +{{ :undefined:screenshot_2023-12-06_at_19.45.35.png?nolink |}}
  
 Note: If tags are already present in your Hierarchy, the imported hierarchy will be added to the right of the existing Root Tags. Note: If tags are already present in your Hierarchy, the imported hierarchy will be added to the right of the existing Root Tags.
Line 87: Line 136:
 ---- ----
  
 +==== 2. Change Question Type and/or Description ====
  
-==== 2. Change Parent Tag ====+To change a Tag's question type, click on the tag of interest, click on the drop-down menu under "Question Type." To change the question being asked, edit the Question text box and remember to click Update.
  
-Sometimes, you want to move a child tag to be nested under a different parent tag. To do so, click the tab of interest and click on the drop-down menu under “Parent Tag”. Changing this will link the tag under a different parent tag. Find the name of the new Parent tag and click “Update” 
  
-{{ :undefined:t1.png?nolink |}}+==== 3Change Parent Tag ====
  
-----+Sometimes, you want to move a child tag to be nested under a different parent tag. To do so, click the tag of interest and click on the drop-down menu under “Parent Tag”. Changing this will link the tag under a different parent tag. Find the name of the new Parent tag and click “Update.”
  
-==== 3Reorder Tags ====+{{ :undefined:screenshot_2023-12-06_at_19.50.46.png?nolink |}}
  
-If you would like to reorder the positioning of tags underneath the parent tag, simply click on the tag you would like to reorder. On the "Edit" menu, use the "Order under Parent" menu to alter the position of the child tag and click "Update." 1 refers to the left-most tag position under the parent tag and higher numbers refer to consecutive positions to the right of this tag. The new ordering will be reflected in the Tagging module, Exports, and Synthesis.+----
  
-Reordering tags is useful for general organization of the hierarchy, which is reflected in NK outputs, as well as order of questions that appear in [[:wiki:autolit:tagging#form-based_tagging|Form-based Tagging mode]].+==== 4Reorder Tags ====
  
-{{ :wiki:autolit:t2.png?nolink |}}+If you would like to reorder the positioning of tags underneath the parent tag, simply click on the tag you would like to reorder. On the "Edit" menu, use the "Order under Parent" menu to alter the position of the child tag and click "Update." 1 refers to the left-most tag position under the parent tag and higher numbers refer to consecutive positions to the right of this tag. The new ordering will be reflected in the Tagging module (specifically the order of questions shown in the form) Exports, and Synthesis. 
 + 
 +Reordering tags is useful for general organization of the hierarchy, which is reflected in NK outputs, as well as order of questions that appear in Tagging.
  
 ---- ----
  
-==== 4. Tag Contents ====+==== 5. Tag Contents ====
  
-When a tag is created, the default setting is to collect simple text as the contents associated with the tag. If you would like to collect data in the form of a table for a specific tag, instead of just a singular text box, you can toggle on "Gather Table Contents." Learn more about [[wiki:autolit:tagging:tagtables|when to use text vs tag tables.]] +When a tag is created, you have the choice of tag content and the choice to toggle on options for your chosen content. The default setting for content mode is Text, meaning when the tag is applied, free text can be inputted alongsideOptions for the content mode are switched off by default. 
 + 
 +=== Content Mode: Text vs Tables === 
 + 
 +If you would like to collect data in the form of a table for a specific tag, instead of just a singular text box, you can select "Table" in the Content Mode dropdown and customize a table. Learn more about [[wiki:autolit:tagging:tagtables|when to use text vs tag tables.]]  
 + 
 +=== Content Options === 
 + 
 +Once you have chosen the tag's content mode, you may wish to configure options. Turning on options allows you to configure pre-determined options to select from when applying a tag, //instead of inputting free text.// Learn more about [[wiki:autolit:tagging:options|how to configure options.]] 
 + 
 +----
  
-==== 5. Hide Tags ====+==== 6. Hide Tags ====
  
 If you have tags present in your hierarchy that you do not want shown in Synthesis (e.g. if they are used for admin/organizational purposes) you can hide them. They will **only** be hidden in Synthesis and still accessible to use everywhere else in AutoLit. To hide a tag, click on the tag and under the "Hide" menu, toggle on "Hide on Synthesis."  If you have tags present in your hierarchy that you do not want shown in Synthesis (e.g. if they are used for admin/organizational purposes) you can hide them. They will **only** be hidden in Synthesis and still accessible to use everywhere else in AutoLit. To hide a tag, click on the tag and under the "Hide" menu, toggle on "Hide on Synthesis." 
Line 120: Line 181:
 ---- ----
  
-==== 6. Merge Tags ====+==== 7. Merge Tags ====
  
 If you would like to combine multiple tags into one tag, click on the tag that you would like to merge into the other. Use the “Target Tag” menu to find the tag you would like to merge with and then click the “Merge” button. If you would like to combine multiple tags into one tag, click on the tag that you would like to merge into the other. Use the “Target Tag” menu to find the tag you would like to merge with and then click the “Merge” button.
  
-{{ :undefined:merge.png?nolink |}}+{{ :undefined:screenshot_2023-12-06_at_19.53.43.png?nolink |}}
  
 **//Why would you Merge tags? Either because they are duplicates or because they are concepts you would like to combine.// ** **//Why would you Merge tags? Either because they are duplicates or because they are concepts you would like to combine.// **
Line 130: Line 191:
 ---- ----
  
-==== 7. Delete Tags ====+==== 8. Delete Tags ====
  
 Find the tag you would like to delete, Click the “Delete” button on the top right, click the “Confirm” square, then click “Update”. **//When a tag is deleted in Configure Tagging, it deletes the tag from the hierarchy and from all studies it has been applied to.// ** Find the tag you would like to delete, Click the “Delete” button on the top right, click the “Confirm” square, then click “Update”. **//When a tag is deleted in Configure Tagging, it deletes the tag from the hierarchy and from all studies it has been applied to.// **
Line 140: Line 201:
 </WRAP>// ** </WRAP>// **
  
-{{ :undefined:de.png?nolink |}}+{{ :undefined:screenshot_2023-12-06_at_19.54.56.png?nolink |}}
  
 === Recursively Delete Tags === === Recursively Delete Tags ===
Line 148: Line 209:
 To Recursively Delete, select the check-box for "Recursively Delete?" and for "Confirm" before clicking "Delete." As with deleting single tags, this cannot be undone! To Recursively Delete, select the check-box for "Recursively Delete?" and for "Confirm" before clicking "Delete." As with deleting single tags, this cannot be undone!
  
-==== 7. Add Tags on the Fly ====+==== 9. Add Tags on the Fly ====
  
 If you forget to configure a tag before beginning the Tagging process, no problem! You can add tags to your hierarchy 'on the fly'; to learn how, click [[:wiki:autolit:tagging:tag#add_new_tags_on_the_fly|here]]. If you forget to configure a tag before beginning the Tagging process, no problem! You can add tags to your hierarchy 'on the fly'; to learn how, click [[:wiki:autolit:tagging:tag#add_new_tags_on_the_fly|here]].
  
  
wiki/autolit/tagging/configure.1692664756.txt.gz · Last modified: 2023/08/22 00:39 by kevinkallmes