Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-517

Add additional information about why a file is unable to load

    Details

    • Type: Improvement
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
    • Story Points:
      1
    • Sprint:
      Winter 2018 Sprint 3, Spring 2019 Sprint 1

      Description

      Several people have posted in Biostars about how they have had difficulty opening files in IGB (see https://www.biostars.org/p/107856/#136590 for an example). Ultimately the issue is not with IGB, but that the files do not match the correct standard. For example, there was no header information in a WIG file, or there was a BED file embedded inside of a WIG file.

      However, if a file is an accepted format, but does not follow a standard format, the user is only told that IGB is "Unable to load data set for this file." In the future it may be helpful to the user to provide more information as to why the file was unable to load, i.e. no header/track line given, number of columns does not match accepted format, etc. This would allow the user to better diagnose the issue, and help keep them from immediately placing the fault on IGB.

        Attachments

        1. brokenBed.bed
          0.2 kB
        2. unableToLoad.png
          unableToLoad.png
          231 kB
        3. workingBed.bed
          0.2 kB

          Issue Links

            Activity

            Hide
            aloraine Ann Loraine added a comment - - edited

            Tasks:

            • To improve the user experience, change the message to read:

            "IGB is unable to load the data in your file. One problem might be that the file format does not match IGB expectations. More information about what went wrong may be available in the Console. To get help, visit the IGB Help Page."

            Link "IGB Help Page" to https://bioviz.org/help.html

            • All IGB user-facing text is configured in a text file. Check whether this text is in that file.
            • Determine if you can embed a hyperlink in the error message window.
            • Review the user experience w/ Dr. Freese and/or other IGB users.
            Show
            aloraine Ann Loraine added a comment - - edited Tasks: To improve the user experience, change the message to read: "IGB is unable to load the data in your file. One problem might be that the file format does not match IGB expectations. More information about what went wrong may be available in the Console. To get help, visit the IGB Help Page." Link "IGB Help Page" to https://bioviz.org/help.html All IGB user-facing text is configured in a text file. Check whether this text is in that file. Determine if you can embed a hyperlink in the error message window. Review the user experience w/ Dr. Freese and/or other IGB users.
            Hide
            svallapu Sai Charan Reddy Vallapureddy added a comment -

            Branch Link:
            https://bitbucket.org/svallapu/charan_igb/branch/IGBF-517#diff

            latest commit: f8f1f99

            I have changed the error message and added link to the dialog box. Previously the message object is just a "string", now I have changed the object to "JEditorPane" to support links in the string.

            Show
            svallapu Sai Charan Reddy Vallapureddy added a comment - Branch Link: https://bitbucket.org/svallapu/charan_igb/branch/IGBF-517#diff latest commit: f8f1f99 I have changed the error message and added link to the dialog box. Previously the message object is just a "string", now I have changed the object to "JEditorPane" to support links in the string.
            Hide
            nfreese Nowlan Freese added a comment -

            1st level review:
            Appears to be working correctly. When a "broken" file with a recognized extension (i.e. .bed) is loaded in IGB the user is presented with "IGB is unable to load the data in your file. One problem might be that the file format does not match IGB expectations. More information about what went wrong may be available in the Console. To get help, visit the IGB Help Page."

            Show
            nfreese Nowlan Freese added a comment - 1st level review: Appears to be working correctly. When a "broken" file with a recognized extension (i.e. .bed) is loaded in IGB the user is presented with "IGB is unable to load the data in your file. One problem might be that the file format does not match IGB expectations. More information about what went wrong may be available in the Console. To get help, visit the IGB Help Page ."
            Hide
            nfreese Nowlan Freese added a comment - - edited

            Testing Mac: Working correctly

            Note: This issue is heavily related to 1515, which requires further testing.

            Show
            nfreese Nowlan Freese added a comment - - edited Testing Mac: Working correctly Note: This issue is heavily related to 1515, which requires further testing.
            Hide
            karthik Karthik Raveendran added a comment -

            Testing Mac: Working correctly

            Note: This issue is heavily related to 1515, which requires further testing.

            Show
            karthik Karthik Raveendran added a comment - Testing Mac: Working correctly Note: This issue is heavily related to 1515, which requires further testing.
            Hide
            svallapu Sai Charan Reddy Vallapureddy added a comment -

            Testing Linux: Working correctly

            Note: This issue is heavily related to 1515, which requires further testing.

            Show
            svallapu Sai Charan Reddy Vallapureddy added a comment - Testing Linux: Working correctly Note: This issue is heavily related to 1515, which requires further testing.
            Hide
            nfreese Nowlan Freese added a comment -

            Karthik tested on Windows.

            Show
            nfreese Nowlan Freese added a comment - Karthik tested on Windows.

              People

              • Assignee:
                svallapu Sai Charan Reddy Vallapureddy
                Reporter:
                nfreese Nowlan Freese
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: