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

Document instructions for compiling FindJunctions via Bitbucket

    Details

    • Type: Documentation
    • Status: Pull Request Submitted (View Workflow)
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      In the "Using FindJuctions from the command line" section from the Find Junctions page of the user's guide (linked here), it says, "Follow the instructions to compile FindJunctions and create a "jar" file." However, there are currently no instructions present in the FindJunctions repo on Bitbucket.

      Task: Add instructions for how a user can compile FindJunctions and create a "jar" file to the README file in the FindJunctions repo.

        Attachments

          Issue Links

            Activity

            jsirigin Jaya Sravani Sirigineedi made changes -
            Assignee Jaya Sravani Sirigineedi [ jsirigin ]
            jsirigin Jaya Sravani Sirigineedi made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            jsirigin Jaya Sravani Sirigineedi made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            jsirigin Jaya Sravani Sirigineedi made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            jsirigin Jaya Sravani Sirigineedi made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            jsirigin Jaya Sravani Sirigineedi made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            Hide
            jsirigin Jaya Sravani Sirigineedi added a comment -

            Updated Ann Loraine. Tested it again, it's working as expected. https://bitbucket.org/lorainelab/findjunctions/pull-requests/1

            Show
            jsirigin Jaya Sravani Sirigineedi added a comment - Updated Ann Loraine . Tested it again, it's working as expected. https://bitbucket.org/lorainelab/findjunctions/pull-requests/1
            ann.loraine Ann Loraine made changes -
            Assignee Jaya Sravani Sirigineedi [ jsirigin ]
            ann.loraine Ann Loraine made changes -
            Status Reviewing Pull Request [ 10303 ] To-Do [ 10305 ]
            ann.loraine Ann Loraine made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            Hide
            ann.loraine Ann Loraine added a comment -

            Small change request:

            Show
            ann.loraine Ann Loraine added a comment - Small change request: Please remove this repository reference from the POM: http://eos.transvar.org/nexus/content/repositories/freehep-maven/
            jsirigin Jaya Sravani Sirigineedi made changes -
            Assignee Jaya Sravani Sirigineedi [ jsirigin ]
            jsirigin Jaya Sravani Sirigineedi made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            Hide
            jsirigin Jaya Sravani Sirigineedi added a comment -

            Raised pull request: https://bitbucket.org/lorainelab/findjunctions/pull-requests/1. Please review and let me know if there are any issues.

            Show
            jsirigin Jaya Sravani Sirigineedi added a comment - Raised pull request: https://bitbucket.org/lorainelab/findjunctions/pull-requests/1 . Please review and let me know if there are any issues.
            nfreese Nowlan Freese made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ] Jaya Sravani Sirigineedi [ jsirigin ]
            Hide
            nfreese Nowlan Freese added a comment -

            I am able to build FindJunctions using mvn and then run the runFJ.sh to produce a bed file. I am also able to create a bed file using the FindJunction_exe.jar.

            Ready for pull request.

            Show
            nfreese Nowlan Freese added a comment - I am able to build FindJunctions using mvn and then run the runFJ.sh to produce a bed file. I am also able to create a bed file using the FindJunction_exe.jar. Ready for pull request.
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ]
            nfreese Nowlan Freese made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            Hide
            jsirigin Jaya Sravani Sirigineedi added a comment -

            Thanks Nowlan Freese for finding that out, I missed that -u option when running it from the terminal that's why I was getting the output from the terminal and not from the script. Updated the READMe file and included the script changes as well: https://bitbucket.org/jaya-sravani/findjunctions/branch/IGBF-3679

            Show
            jsirigin Jaya Sravani Sirigineedi added a comment - Thanks Nowlan Freese for finding that out, I missed that -u option when running it from the terminal that's why I was getting the output from the terminal and not from the script. Updated the READMe file and included the script changes as well: https://bitbucket.org/jaya-sravani/findjunctions/branch/IGBF-3679
            Hide
            nfreese Nowlan Freese added a comment - - edited

            Jaya Sravani Sirigineedi - The example bash script above includes "-u" which outputs uniquely mapped reads only. My guess would be that the example reads in the 1.bam file are not uniquely mapped, and so the output was empty. When I removed the "-u" the bed files were no longer empty.

            Edits to the Readme:

            • I think you can get rid of lines 27-29 as they are included in the example.
            • It may be worth including the current FindJunctions options (see below), or tell the user how to see them.
            • What is the "-n 10" in the example for running the jar without building FindJunctions? Is that equivalent to the -f flank option?

            FindJunctions options:

             -b,--twobit <2BIT>   2bit file with genomic sequence [required]
             -f,--flank <FLANK>   read bases required to flank intron [default is 5]
             -h,--help            print usage information
             -o,--output <OUT>    write output to file [optional]
             -u,--unique          uniquely mapped reads only [optional]
             -v,--verbose         enables debug logging [optional]
            
            Show
            nfreese Nowlan Freese added a comment - - edited Jaya Sravani Sirigineedi - The example bash script above includes "-u" which outputs uniquely mapped reads only. My guess would be that the example reads in the 1.bam file are not uniquely mapped, and so the output was empty. When I removed the "-u" the bed files were no longer empty. Edits to the Readme: I think you can get rid of lines 27-29 as they are included in the example. It may be worth including the current FindJunctions options (see below), or tell the user how to see them. What is the "-n 10" in the example for running the jar without building FindJunctions? Is that equivalent to the -f flank option? FindJunctions options: -b,--twobit <2BIT> 2bit file with genomic sequence [required] -f,--flank <FLANK> read bases required to flank intron [ default is 5] -h,--help print usage information -o,--output <OUT> write output to file [optional] -u,--unique uniquely mapped reads only [optional] -v,--verbose enables debug logging [optional]
            jsirigin Jaya Sravani Sirigineedi made changes -
            Assignee Jaya Sravani Sirigineedi [ jsirigin ]
            jsirigin Jaya Sravani Sirigineedi made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            Hide
            jsirigin Jaya Sravani Sirigineedi added a comment - - edited

            Fixed the build issue and modified the README.md file to include the steps to build and run the application. Updated code is available at the branch: https://bitbucket.org/jaya-sravani/findjunctions/branch/IGBF-3679. Also, I tried including this run step in a shell script file, but when i run the file the output bed file is empty when the same command is run in terminal it is working, Nowlan Freese could you please check this on your system as well and let me know if it's working for you. Clone the above branch and change the runFJ.sh file content to below:

            #!/bin/bash
            
            JAR="target/find-junctions-1.0.0-jar-with-dependencies.jar"
            TWOBIT="src/test/resources/A_thaliana_Jun_2009.2bit"
            BAM="src/test/resources/1.bam"
            FLANK="10"
            OUT="test.bed"
            
            java -Xmx1g -jar $JAR -f $FLANK -b $TWOBIT -u -o $OUT $BAM
            java -Xmx512m -jar $JAR -b $TWOBIT -u -f $FLANK -o test1.bed $BAM
            

            With the instructions provided in the README.md file you should now be able to run the FindJunctions jar and get the bed file as output.

            Show
            jsirigin Jaya Sravani Sirigineedi added a comment - - edited Fixed the build issue and modified the README.md file to include the steps to build and run the application. Updated code is available at the branch: https://bitbucket.org/jaya-sravani/findjunctions/branch/IGBF-3679 . Also, I tried including this run step in a shell script file, but when i run the file the output bed file is empty when the same command is run in terminal it is working, Nowlan Freese could you please check this on your system as well and let me know if it's working for you. Clone the above branch and change the runFJ.sh file content to below: #!/bin/bash JAR= "target/find-junctions-1.0.0-jar-with-dependencies.jar" TWOBIT= "src/test/resources/A_thaliana_Jun_2009.2bit" BAM= "src/test/resources/1.bam" FLANK= "10" OUT= "test.bed" java -Xmx1g -jar $JAR -f $FLANK -b $TWOBIT -u -o $OUT $BAM java -Xmx512m -jar $JAR -b $TWOBIT -u -f $FLANK -o test1.bed $BAM With the instructions provided in the README.md file you should now be able to run the FindJunctions jar and get the bed file as output.
            jsirigin Jaya Sravani Sirigineedi made changes -
            pkulzer Paige Kulzer made changes -
            Description In the "Using FindJuctions from the command line" section, it says, "Follow the instructions to compile FindJunctions and create a "jar" file." However, there are currently no instructions present in the [FindJunctions repo|https://bitbucket.org/lorainelab/findjunctions/src/master/] on Bitbucket.

            Task: Add instructions for how a user can compile FindJunctions and create a "jar" file to the README file in the FindJunctions repo.
            In the "Using FindJuctions from the command line" section from the Find Junctions page of the user's guide ([linked here|https://wiki.bioviz.org/confluence/display/igbman/FindJunctions]), it says, "Follow the instructions to compile FindJunctions and create a "jar" file." However, there are currently no instructions present in the [FindJunctions repo|https://bitbucket.org/lorainelab/findjunctions/src/master/] on Bitbucket.

            Task: Add instructions for how a user can compile FindJunctions and create a "jar" file to the README file in the FindJunctions repo.
            jsirigin Jaya Sravani Sirigineedi made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            jsirigin Jaya Sravani Sirigineedi made changes -
            Assignee Jaya Sravani Sirigineedi [ jsirigin ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Sprint Spring 8, Spring 9 [ 192, 193 ] Spring 8, Spring 9, Spring 10 [ 192, 193, 194 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Sprint Spring 8 [ 192 ] Spring 8, Spring 9 [ 192, 193 ]
            pkulzer Paige Kulzer made changes -
            Assignee Paige Kulzer [ pkulzer ]
            Hide
            pkulzer Paige Kulzer added a comment -

            I've updated the FindJunctions page in the User's Guide (linked here) to mention Apache Maven and direct users to the BitBucket repo.

            I'm unassigning myself from this ticket so that whoever has time to update the compilation instructions in the README can assign themselves and work on it.

            Show
            pkulzer Paige Kulzer added a comment - I've updated the FindJunctions page in the User's Guide (linked here ) to mention Apache Maven and direct users to the BitBucket repo. I'm unassigning myself from this ticket so that whoever has time to update the compilation instructions in the README can assign themselves and work on it.
            nfreese Nowlan Freese made changes -
            Link This issue relates to IGBF-3680 [ IGBF-3680 ]
            ann.loraine Ann Loraine made changes -
            Assignee Paige Kulzer [ pkulzer ]
            Hide
            ann.loraine Ann Loraine added a comment -

            If Jaya Sravani Sirigineedi or Kaushik Gopu has time this sprint, let's try to get this done.

            Meaning: Explain how to compile the project using maven. Add the documentation to the repository itself as PRs.

            Show
            ann.loraine Ann Loraine added a comment - If Jaya Sravani Sirigineedi or Kaushik Gopu has time this sprint, let's try to get this done. Meaning: Explain how to compile the project using maven. Add the documentation to the repository itself as PRs.
            ann.loraine Ann Loraine made changes -
            Assignee Ann Loraine [ aloraine ]
            Hide
            ann.loraine Ann Loraine added a comment -

            Change line above to "Build the jar file using maven. See: [ insert link to bitbucket repository here ]."

            Show
            ann.loraine Ann Loraine added a comment - Change line above to "Build the jar file using maven. See: [ insert link to bitbucket repository here ]."
            pkulzer Paige Kulzer made changes -
            Summary Add instructions for compiling FindJunctions to the README on Bitbucket Document instructions for compiling FindJunctions via Bitbucket
            pkulzer Paige Kulzer made changes -
            Link This issue relates to IGBF-1088 [ IGBF-1088 ]
            pkulzer Paige Kulzer made changes -
            Field Original Value New Value
            Epic Link IGBF-1765 [ 17855 ]
            pkulzer Paige Kulzer created issue -

              People

              • Assignee:
                Unassigned
                Reporter:
                pkulzer Paige Kulzer
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated: