This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
wiki:autolit:tagging:configure [2023/07/07 22:30] jthurnham [7. Add Tags on the Fly] |
wiki:autolit:tagging:configure [2024/01/18 11:09] (current) jthurnham |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Configuring and Editing the Tag Hierarchy ====== | ====== Configuring and Editing the Tag Hierarchy ====== | ||
- | For each nest, you need to configure a Tag Hierarchy before | + | For each nest, you need to configure a Tag Hierarchy before |
To configure a hierarchy for your nest, follow the steps below. Once you have built the hierarchy, you can move on to [[: | To configure a hierarchy for your nest, follow the steps below. Once you have built the hierarchy, you can move on to [[: | ||
- | ---- | + | Before Tag Hierarchy configuration, |
+ | |||
+ | Alternatively, | ||
+ | |||
+ | ===== 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, " | ||
+ | |||
+ | 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. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | ===== Configure Study Tags as Questions & Answers ===== | ||
- | ===== Configuring Study Tags: ===== | ||
- | ==== 1. Navigate to Configure | + | ==== 1. Navigate to Configure Tags ==== |
- | Click " | + | Click on the gears icon in the Tagging tab: |
- | {{:wiki:autolit: | + | {{ :undefined:conftag23.png? |
This will bring you to the Tag Hierarchy, which will be blank until you have added tags. | This will bring you to the Tag Hierarchy, which will be blank until you have added tags. | ||
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 tags. These should | + | To draft Questions, you need to build out the Tags in your Tagging Hierarchy. You should |
- | To create a new Root Tag, click " | + | To start, click " |
- | {{ :wiki:autolit: | + | {{ :undefined:screenshot_2023-12-06_at_19.28.32.png?nolink |}} |
- | Then, name the tag, but leave the " | + | You have the following options for Question types: |
- | {{ :wiki:autolit:tagging: | + | * **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 | + | Generally, it is best to add a full/ |
- | ---- | + | {{ : |
- | ==== 3. Create Child Tags ==== | + | Note: Leaving " |
- | You can build your hierarchy downward by adding tags below the Root Tags. Click " | + | ==== 3. Configure |
- | 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 |
- | ---- | + | 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. |
- | ==== Recommendations in Hierarchy Building ==== | + | {{ : |
- | To see examples | + | ==== Example Questions |
+ | |||
+ | Example Single Select question: | ||
+ | * **Tag Name:** Study Type | ||
+ | * **Question: | ||
+ | * **Answers (child tags):** Randomized Controlled Trial, Prospective Cohort Study, Retrospective Study | ||
+ | |||
+ | Example Multi-Select question: | ||
+ | * **Tag Name:** Comorbidities | ||
+ | * **Question: | ||
+ | * **Answers (child tags):** Diabetes, Hypertension, | ||
+ | |||
+ | Example Single Apply question: | ||
+ | * **Tag Name:** Study Objective | ||
+ | * **Question: | ||
+ | * **Answer** (not child tags, the answer will be reflected by the tag text): Tag Text/ | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | ===== Tips on Preliminary Hierarchy Organization ===== | ||
+ | |||
+ | Every Question that you create | ||
+ | |||
+ | In addition, due to the flexibility of tags, it 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 " | ==== 1. Click " | ||
Line 55: | Line 95: | ||
From the Configure Tagging page, select " | From the Configure Tagging page, select " | ||
- | {{ :wiki:autolit: | + | {{ :undefined:screenshot_2023-12-06_at_19.42.53.png?nolink |}} |
==== 2. Choose a Tag Hierarchy Template ==== | ==== 2. Choose a Tag Hierarchy Template ==== | ||
- | {{ :wiki: | + | 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: | + | - From your organization' |
+ | - From Nested Knowledge' | ||
+ | |||
+ | Learn more on how to import tag templates | ||
=== 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 | + | Then, decide if you want to import the entire hierarchy or only one Root Tag and its children. |
+ | |||
+ | {{ : | ||
+ | |||
+ | To select only one Root Tag and its children, select the Root Tag and then click " | ||
+ | |||
+ | {{ : | ||
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 84: | Line 133: | ||
To change a Tag's name, go to the Tag Hierarchy and click on the tag of interest. Click on the tag and rename the title, and then click “Update”. **//This change will be applied across all studies in the Nest with that tag.// ** | To change a Tag's name, go to the Tag Hierarchy and click on the tag of interest. Click on the tag and rename the title, and then click “Update”. **//This change will be applied across all studies in the Nest with that tag.// ** | ||
- | |||
- | {{ : | ||
---- | ---- | ||
+ | ==== 2. Change Question Type and/or Description ==== | ||
- | ==== 2. Change Parent | + | To change a Tag's question type, click on the tag of interest, click on the drop-down menu under " |
- | 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” | ||
- | {{ : | + | ==== 3. Change 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.” |
- | ==== 3. Reorder 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 " | + | |
- | + | ||
- | 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: | + | |
- | + | ||
- | {{ : | + | |
---- | ---- | ||
- | ==== 4. Tag Contents | + | ==== 4. Reorder Tags ==== |
- | 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 | + | If you would like to reorder |
- | {{ : | + | 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. |
- | After toggling on Gather Table Contents, you can customize the columns of your table for data extraction. Note: this feature is tag-specific, it only applies to tags where it is toggled on and tables are created from scratch for each tag of choice. | + | ---- |
- | To add columns, type in the column title and click Add. The columns will be added below, and can be reordered, edited or deleted anytime. A preview is also shown for how the table will look in the Tagging module. | + | ==== 5. Tag Contents ==== |
- | {{ : | + | 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 alongside. Options for the content mode are switched off by default. |
- | Each tag may only have a text //or// a table contents. You may toggle Gather Table Contents on and off anytime, and the customized columns will be restored when turned back on. When clicking out of the modal, you will see tags with Gather Table Contents on now have a square-shaped tag to differentiate from tags with text content (round tags). Tags with table contents do not affect child tags. | + | === 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 " |
- | Note: Configuring tags with table contents is compatible with all tagging | + | === 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: | ||
---- | ---- | ||
- | + | ==== 6. Hide Tags ==== | |
- | ==== 5. 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/ | If you have tags present in your hierarchy that you do not want shown in Synthesis (e.g. if they are used for admin/ | ||
- | |||
- | {{ : | ||
This will alter the shape of the tag to differentiate between present and hidden tags in Synthesis. Nothing else changes, and toggling back and forth is non-destructive; | This will alter the shape of the tag to differentiate between present and hidden tags in Synthesis. Nothing else changes, and toggling back and forth is non-destructive; | ||
Line 141: | 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 151: | 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 161: | Line 201: | ||
</ | </ | ||
- | {{ :undefined:de.png?nolink |}} | + | {{ :undefined:screenshot_2023-12-06_at_19.54.56.png?nolink |}} |
=== Recursively Delete Tags === | === Recursively Delete Tags === | ||
Line 169: | Line 209: | ||
To Recursively Delete, select the check-box for " | To Recursively Delete, select the check-box for " | ||
- | ==== 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 [[: | 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 [[: | ||