Nested Knowledge

Bringing Systematic Review to Life

User Tools

Site Tools


wiki:autolit:utilities:inspector

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:utilities:inspector [2024/06/14 14:46]
jthurnham [Adjusting the Columns in Inspector]
wiki:autolit:utilities:inspector [2024/09/20 15:34] (current)
jthurnham [Explore from Inspector]
Line 21: Line 21:
  
 {{ :undefined:screenshot_2024-06-14_at_15.18.33.png?nolink |}} {{ :undefined:screenshot_2024-06-14_at_15.18.33.png?nolink |}}
 +
 +=== 2a. Advanced Study Inspector ===
  
 You can use multiple filters, which are layered on top of each other (e.g. filtering to "Screening Status: Included" **and** "Title/Abstract: Randomized" will filter to all included articles with the word "randomized" in the title or abstract). This "filter layering" is the default setting for multiple filters in the simplified Study Inspector mode. If you'd like to add filters in an alternate fashion e.g. you want to filter to included studies **or** those with a specific tag, explore how to use the [[wiki:autolit:utilities:inspector:advanced|Advanced Study Inspector mode.]] You can use multiple filters, which are layered on top of each other (e.g. filtering to "Screening Status: Included" **and** "Title/Abstract: Randomized" will filter to all included articles with the word "randomized" in the title or abstract). This "filter layering" is the default setting for multiple filters in the simplified Study Inspector mode. If you'd like to add filters in an alternate fashion e.g. you want to filter to included studies **or** those with a specific tag, explore how to use the [[wiki:autolit:utilities:inspector:advanced|Advanced Study Inspector mode.]]
Line 29: Line 31:
  
 {{ :undefined:screenshot_2024-06-14_at_15.35.21.png?nolink |}} {{ :undefined:screenshot_2024-06-14_at_15.35.21.png?nolink |}}
 +
 +For Tag filters in particular, by default you'll see all records with that tag or any child tags below it (this doesn't apply if the tag has no child tags). To see records that have that tag only select the star to the left of the filter (red box):
 +
 +{{ :undefined:screenshot_2024-06-14_at_16.48.43.png?nolink |}}
  
 For a detailed list of the types of filters available, check out the [[:wiki:autolit:utilities:inspector:filters|Study Inspector Filters page]]. For a detailed list of the types of filters available, check out the [[:wiki:autolit:utilities:inspector:filters|Study Inspector Filters page]].
Line 38: Line 44:
 ===== Adjusting the Columns in Inspector ===== ===== Adjusting the Columns in Inspector =====
  
-You can select the columns that you want to view in Inspector by clicking on the three dots to the far right of the Inspector header row. Any columns you select will be added to the Inspector view and, if you wish to Download data, these columns are alsoadded to the spreadsheet.+You can select the columns that you want to view in Inspector by clicking on the three dots (red) to the far right of the Inspector header row. Any columns you select will be added to the Inspector view and, if you wish to Download data, these columns are alsoadded to the spreadsheet. 
 + 
 +{{ :undefined:screenshot_2024-09-20_at_13.27.23.png?nolink |}}
  
 Click on any of the following to add them as columns in Inspector: Click on any of the following to add them as columns in Inspector:
Line 54: Line 62:
   * Final Screening Status   * Final Screening Status
   * //If Dual mode is turned on you will see the following filters://   * //If Dual mode is turned on you will see the following filters://
-      * **Your Screening Status:** This refers to the screening decision you made for the record +      * **Your Screening Status:**  This refers to the screening decision you made for the record 
-      * **Screening Adjudicated By:** The user's name that adjudicated the record is displayed +      * **Screening Adjudicated By:**  The user's name that adjudicated the record is displayed 
-      * **Reviewer Screened By:** The users' names that reviewed the record are displayed+      * **Reviewer Screened By:**  The users' names that reviewed the record are displayed
   * //If Dual Two Pass mode is turned on, you will see the following filters://   * //If Dual Two Pass mode is turned on, you will see the following filters://
-      * **Your Full Text Screening Status:** This refers to the FT screening decision you made for the record +      * **Your Full Text Screening Status:**  This refers to the FT screening decision you made for the record 
-      * **Abstract Screening Status:** This refers to the final abstract screening decision made for the record +      * **Abstract Screening Status:**  This refers to the final abstract screening decision made for the record 
-      * **Your Abstract Screening Status:** This refers to the abstract screening decision you made for the record +      * **Your Abstract Screening Status:**  This refers to the abstract screening decision you made for the record 
-      * **FT Screening Adjudicated By:** The user's name that adjudicated the record after FT screening is displayed +      * **FT Screening Adjudicated By:**  The user's name that adjudicated the record after FT screening is displayed 
-      * **Reviewer FT Screened By:** The users' names that reviewed the record at the FT level are displayed +      * **Reviewer FT Screened By:**  The users' names that reviewed the record at the FT level are displayed 
-      * **AB Screening Adjudicated By:** The user's name that adjudicated the record after Abstract screening is displayed +      * **AB Screening Adjudicated By:**  The user's name that adjudicated the record after Abstract screening is displayed 
-      * **Reviewer AB Screened By:** The users' names that reviewed the record at the abstract level are displayed +      * **Reviewer AB Screened By:**  The users' names that reviewed the record at the abstract level are displayed 
-  * Tagging: This refers to Complete or Incomplete module status +  * Tagging Status: This refers to Complete or Incomplete module status 
-  * Meta-Analytical Extraction: This refers to Complete or Incomplete module status +  * Meta-Analytical Extraction Status: This refers to Complete or Incomplete module status 
-  * Critical Appraisal: This refers to Complete or Incomplete module status +  * Critical Appraisal Status: This refers to Complete or Incomplete module status 
-  * Inclusion Probability: If turned on, this refers to the calculated inclusion probability for the record +  * Advancement/Inclusion Probability: If turned on, this refers to the calculated advancement/inclusion probability for the record 
-  * Tags: Alist of tags applied+  * Tags: Choose from the list of tags in your hierarchy, then choose if you'd like to view Tag Name, its Contents or both in the Inspector column.
   * DOI   * DOI
   * PubMed ID   * PubMed ID
Line 78: Line 86:
   * Full Text Status: This refers to if and how the Full Text was uploaded   * Full Text Status: This refers to if and how the Full Text was uploaded
   * Author List   * Author List
-  * Full Citation [[https://guides.med.ucf.edu/jama|(JAMA format)]]+  * Full Citation: All citations or references in Nested Knowledge are presented in [[https://guides.med.ucf.edu/jama|(JAMA format)]].
   * Related Report Family: If the record is part of a related report family, the name will be displayed   * Related Report Family: If the record is part of a related report family, the name will be displayed
  
-Click on any column that has a check mark next to it (indicating it is a current column) to remove itMake sure to avoid adding too many columns to limit crowding!+Check and uncheck columns to add and remove them from the Inspector display, you may also reorder columns via drag and drop of the below pills.
  
 +----
  
-===== Quick Guide: Download and Bulk Actions =====+===== Completing Actions on Individual Studies in Inspector =====
  
-Inspector is the location for two very important activities: Downloading/exporting and completing Bulk Actions.+==== 1Opening the Study Modal ====
  
-==== Download from Inspector ====+Once you have filtered to the list of studies of interest, you can screen, tag, or extract by clicking on the study in question; this opens the Study Modal. The modal opens to the module that was selected as the preset; so, if you opened the Screening Study Inspector, for instance, you will be able to screen the study in question.
  
-Download enables you to download content from your nest--either for all studies, or for a specific set of studies you filter to. For full instructions, see [[wiki:autolit:utilities:inspector:download|here]].+==== 2Completing Actions ====
  
-Quick Guide: +The modal enables you to [[:wiki:autolit:screening|Screen]][[:wiki:autolit:tagging|Tag]][[:wiki:autolit:meta_analytical_extraction|MA Extract]], [[:wiki:autolit:critical_appraisal|Critically Appraise]] the study that you have opened. In the modal, the actions are completed in the same way they are completed in the sequential screen/tag/MA extract/critical appraisal modes.
-  * Firstapply all filters to determine which records will be exported. +
-  * Thenmake sure that you have the Columns in Inspector you want exported. The Inspector columns will all be exported into any CSV output! +
-  * Only once filters and columns are ready, **Click Download** in the upper right. +
-  * Select the content that you want exported (e.g. to get metadata, click Studies. to get tags, click Tags). +
-  * If relevant, provide any other details (e.g. if you want a RIS file for Studies instead of a CSV, or whether you want Tables to export for Tags). +
-  * Click "Download" within the modal. Your file should appear in your local Downloads!+
  
-==== Bulk Actions ====+When opening up a study, you'll recognise the format for the left-hand abstract or full text as it mirrors the format shown in the sequential modules (Screening, Tagging etc.); you can view Abstract, Full Text, Supplements and Related Reports. The right-hand panel (red box below) differs as it includes and allows you toggle between modules of interest to view decisions and make edits.
  
-Bulk Actions allow you to complete certain steps (changing screening statusuploading full texts, editing module status, etc.) on studies; for full instructions, see [[:wiki:autolit:utilities:inspector:bulk_actions|here]].+  * AB = Abstract Screening module 
 +  * FT = Full Text Screening module (note: these are only separated out in Two-Pass modeif your nest is configured for Standard it will say "Screen"
 +  * Tag = Tagging module 
 +  * MA Extract = MA Extraction module 
 +  * Appraisal = Critical Appraisal module
  
-{{ :undefined:screenshot_2024-06-14_at_15.13.33.png?nolink |}}+(MA Extract and Appraisal are optional modules and will only be shown when turned on)
  
-Quick Guide: +Selecting between these tabs alters the right-hand panel and tabs accordinglyYou can click the arrow keys to the left and right of the modal (blue box) to move up and down the list of studies available in Study Inspector.
-  * First, **apply all filters that narrow in on the studies you want to complete an action on!** If you 'bulk act' before filtering, you will execute the action on a wider range of studies than intended. +
-  * Then, click Bulk Actions in the upper right+
-  * Select your Bulk Action of interest -- e.g., if you want to bulk-alter Screening Decisions, select "Update Screening"+
-  * If Updating Screening, Tags, Module Status, or importing Full Texts, follow the instructions in the modal. For example, if altering a Screening Decision, you may need to select "Full Text Screening" and "Final Decisions" if you are in Dual, Two-pass mode. +
-  * Complete the bulk action and wait for the job to complete. Optionally, you can click out of the progress modal; the job will continue in the background.+
  
 +{{  :undefined:screenshot_2024-06-14_at_15.52.49.png?nolink&  }}
  
 ---- ----
  
-===== Completing Actions on Individual Studies in Inspector =====+==== 3. Screening in Study Inspector ====
  
-==== 1Opening the Study Modal ====+In Dual Screening modes, to view/make/edit your own decision select "You", to view/make/edit an adjudicated decision, select "Adjudicate" (red box)Regardless of Screening mode, if a study is excluded it will be bolded in grey, if advanced/included the dark blue button will be replaced by "Advanced" or "Included", if unscreened, no exclusion reason will be selected and the Advance/Include button will be active. In the below example, the record has been "Excluded: No Intervention of interest" (blue box).
  
-Once you have filtered to the list of studies of interestyou can screen, tag, or extract by clicking on the study in question; this opens the Study Modal. The modal opens to the module that was selected as the preset; soif you opened the Screening Study Inspectorfor instance, you will be able to screen the study in question.+To change the screening decision to another exclusion reason, simply select another reason. To advance/include select the Advance/Include button. To unscreenselect the undo arrow (pink box). The number of screening decisions associated with a record is displayed to the right of this button0 = no screening decisions1 = one screening decision and so on.
  
-==== 2Completing Actions ====+{{  :undefined:screenshot_2024-06-14_at_16.31.14.png?nolink&  }}
  
-The modal enables you to [[:wiki:autolit:screening|Screen]], [[:wiki:autolit:tagging|Tag]], and [[:wiki:autolit:meta_analytical_extraction|MA Extract]] the study that you have opened. In the modal, the actions are completed in the same way they are completed in the sequential screen/tag/extract modes. Here, you can see a study that is opened to the Screening module; the screening actions <font inherit/inherit;;#c0392b;;inherit>red square</font>  indicates that this study has been included. Once you complete an actionyou can click the arrow keys to the left and right of the modal <font inherit/inherit;;#c0392b;;inherit>red circles</font>  ) to move up and down the list of studies available in Study Inspector.+In "Adjudicate" mode (red box), adjudicators will be able to see reviewer screening decisions (blue boxand choose to "use" one of their decisions or select their own. Only admins are able to view their own decisions as well as make adjudication decisions, users will only be able to view their own decisions.
  
-{{:wiki:autolit:utilities:study_modal.png}}+{{  :undefined:screenshot_2024-06-14_at_16.32.53.png?nolink&  }}
  
-<WRAP round tip> You can unscreen a single study by going to Study Inspector and then opening the screening tab in the Study Modal. If you click on the "i" icon next to the screening decision, you can "unscreen" that study to put it back in the screening queue to review later. {{  :wiki:autolit:utilities:nine.png?nolink&  }}</WRAP> +----
- +
-==== 3. Toggling Modules ====+
  
-To switch between modules, toggle the buttons in the upper right of the modal ( <font inherit/inherit;;#c0392b;;inherit>red outline</font> ). Regardless of how you opened Study Inspector, you can Screen, Tag, and/or Extract within the modal. Note: If the Nest is in [[:wiki:autolit:screening:dual|Dual Screening]] mode, you will have a fourth option of Adjudication shown as a toggling option (black outline) if you have [[:wiki:autolit:admin:configure|Admin]] privileges; this page is not available to users. +==== 4. Marking Modules Complete/Incomplete for Individual Records ====
- +
-{{:wiki:autolit:utilities:img181.png?nolink&  }} +
- +
-**Warning: **If the Nest is in Dual Screening mode, changes made in the Screening module **will not alter the final/adjudicated Screening Status of the study. **Instead, the change will queue another user screening decision to be adjudicated. To alter final/adjudicated Screening Status from the Study Modal, an Admin must use the Adjudication module to select a finalized option. +
- +
-==== 4. Marking Modules Complete/Incomplete for Individual Records  ====+
  
 Marking a module "Complete" removes it from the queue in the corresponding module and marking a module "Incomplete" puts the record back into the queue in the corresponding module. Regardless of module status, records are always editable in Study Inspector. This is specific to the Tagging, Extraction and Critical Appraisal modules. Marking a module "Complete" removes it from the queue in the corresponding module and marking a module "Incomplete" puts the record back into the queue in the corresponding module. Regardless of module status, records are always editable in Study Inspector. This is specific to the Tagging, Extraction and Critical Appraisal modules.
Line 144: Line 139:
 To do this, you can filter to a group of studies and use Bulk Actions (above) and you can also do this within individual studies. Under each menu, open the "History" tab, select Module Status Dropdown and select Complete or Incomplete. To do this, you can filter to a group of studies and use Bulk Actions (above) and you can also do this within individual studies. Under each menu, open the "History" tab, select Module Status Dropdown and select Complete or Incomplete.
  
-{{ :wiki:autolit:utilities:mark.png?nolink |}}+{{  :undefined:screenshot_2024-06-14_at_16.35.44.png?nolink&  }}
  
 ==== 5. Edit Bibliographic Information ==== ==== 5. Edit Bibliographic Information ====
Line 152: Line 147:
 ==== 6. Using Nested Knowledge's Reference ID (Ref ID) ==== ==== 6. Using Nested Knowledge's Reference ID (Ref ID) ====
  
-Nested Knowledge automatically generates a Ref ID for every record that can be used for filtering, bulk actions, and allocation. See details [[wiki:autolit:search:refids|here]].+Nested Knowledge automatically generates a Ref ID for every record that can be used for filtering, bulk actions, and allocation. See details [[:wiki:autolit:search:refids|here]].
  
 ==== 7. Download Individual Study PDFs ==== ==== 7. Download Individual Study PDFs ====
Line 158: Line 153:
 When viewing individual studies, either in Study Inspector or in the module queues, you can download the individual annotated pdf by selecting the three dots and clicking Download (below in red). When viewing individual studies, either in Study Inspector or in the module queues, you can download the individual annotated pdf by selecting the three dots and clicking Download (below in red).
  
-{{ :undefined:screenshot_2024-05-22_at_13.16.10.png?nolink |}}+{{  :undefined:screenshot_2024-05-22_at_13.16.10.png?nolink&  }}
  
 The annotated pdf will display tags applied: The annotated pdf will display tags applied:
  
-{{ :undefined:unnamed.png?nolink |}}+{{  :undefined:unnamed.png?nolink&  }}
  
 ---- ----
 +
 ===== Explore from Inspector ===== ===== Explore from Inspector =====
  
-If you have questions about the contents across your included records, you can use [[:wiki:autolit:search:exploration|Explore from Inspector]], where the RoboPICO, Topic Modeling, and Keyword frequency can be applied to any subset of studies from your nest.+If you have questions about the contents across your included records, you can use [[:wiki:autolit:search:exploration|Explore from Inspector]], where the RoboPICO, Topic Modeling, and Keyword frequency can be applied to any subset of studies from your nest. To do this, select "Explore"
  
-{{:wiki:autolit:utilities:img180.png?nolink&  }}+{{  :undefined:screenshot_2024-06-14_at_16.39.06.png?nolink&  }}
  
-**Note:** Anytime there is a module box with the adjustable icon, you can drag to adjust the width of the box depending on your preference.+This displays the same outputs as Search Exploration giving you a snapshot of PICOsStudy Type, Study Location, Study Size, Topics, Acronyms, and Keywords. It does not include Abstracts (since you can view them in the individual studies themselves), but includes an additional snapshot of the frequency of records over a range of publication dates:
  
-{{ :wiki:autolit:utilities:width_study.png?nolink |}}+{{ :undefined:screenshot_2024-09-20_at_16.31.36.png?nolink |}} 
 + 
 +**Note:**  Anytime there is a module box with the adjustable icon, you can drag to adjust the width of the box depending on your preference. 
 + 
 +{{  :undefined:screenshot_2024-06-14_at_16.41.01.png?nolink&  }} 
 + 
 + 
 +===== Quick Guide: Download and Bulk Actions ===== 
 + 
 +Inspector is the location for two very important activities: Downloading/exporting and completing Bulk Actions. 
 + 
 +==== Download from Inspector ==== 
 + 
 +Download enables you to download content from your nest--either for all studies, or for a specific set of studies you filter to. For full instructions, see [[wiki:autolit:utilities:inspector:download|here]]. 
 + 
 +Quick Guide: 
 +  * First, apply all filters to determine which records will be exported. 
 +  * Then, make sure that you have the Columns in Inspector you want exported. The Inspector columns will all be exported into any CSV output! 
 +  * Only once filters and columns are ready, **Click Download** in the upper right. 
 +  * Select the content that you want exported (e.g. to get metadata, click Studies. to get tags, click Tags). 
 +  * If relevant, provide any other details (e.g. if you want a RIS file for Studies instead of a CSV, or whether you want Tables to export for Tags). 
 +  * Click "Download" within the modal. Your file should appear in your local Downloads! 
 + 
 +==== Bulk Actions ==== 
 + 
 +Bulk Actions allow you to complete certain steps (changing screening status, uploading full texts, editing module status, etc.) on studies; for full instructions, see [[:wiki:autolit:utilities:inspector:bulk_actions|here]]. 
 + 
 +{{ :undefined:screenshot_2024-06-14_at_15.13.33.png?nolink |}} 
 + 
 +Quick Guide: 
 +  * First, **apply all filters that narrow in on the studies you want to complete an action on!** If you 'bulk act' before filtering, you will execute the action on a wider range of studies than intended. 
 +  * Then, click Bulk Actions in the upper right. 
 +  * Select your Bulk Action of interest -- e.g., if you want to bulk-alter Screening Decisions, select "Update Screening"
 +  * If Updating Screening, Tags, Module Status, or importing Full Texts, follow the instructions in the modal. For example, if altering a Screening Decision, you may need to select "Full Text Screening" and "Final Decisions" if you are in Dual, Two-pass mode. 
 +  * Complete the bulk action and wait for the job to complete. Optionally, you can click out of the progress modal; the job will continue in the background. 
 + 
 + 
 +----
wiki/autolit/utilities/inspector.1718376382.txt.gz · Last modified: 2024/06/14 14:46 by jthurnham