TAMU-CPT / training-material

A collection of Galaxy-related training material
https://training.galaxyproject.org
Other
3 stars 9 forks source link

Generate a Galaxy FAQ in GTN style #16

Closed jrr-cpt closed 5 years ago

jrr-cpt commented 6 years ago

@ToniNittolo Start the skeleton for a FAQ on Galaxy common problems. Make it as a Q&A style list with the answers viewable by clicking on a + to expand the box. Here are some starters. We will add more.

  1. One of my datasets turned red, what do I do?

    • Click on the bug icon. READ the message. It may give you a clue. Maybe you used the wrong input. If you cannot figure it out, type in a small message and submit it. CPT IT staff will respond as soon as they can. Unless you are changing some parameter to attempt to fix the problem, do not rerun your job. It just clogs your history with stalled jobs. Examples of common errors:
    • user did not enter common name - this is where you need to choose the phage name from the drop-down box or type in a new name for your new organism
    • wrong input, triple check the file that the tool requires as input. If you have the wrong file type, search the list of tools to for a converter.
    • wrong tool used - read the blurb below each tool to make sure it does what you think it should
  2. I am seeing an error message in Galaxy, how do I report it?

  3. Nothing is working.

    • Check to make sure you are logged in. Try logging in using an incognito window. Check your internet connection.

Idea for a FAQ? Submit feedback via the form below. (we will add a form)

jrr-cpt commented 5 years ago

@ToniNittolo Copy the Failed Datasets section from Intro to CPT Galaxy. Add the things above too.

ToniNittolo commented 5 years ago

This page is now up-to-date with what is listed above.

jrr-cpt commented 5 years ago

@ToniNittolo RE: the code of contributors at the bottom. Please fix according to solution used here: https://github.com/TAMU-CPT/training-material/issues/23

ToniNittolo commented 5 years ago

To ensure that you're seeing the changes, execute git pull in the terminal.

jrr-cpt commented 5 years ago

@ToniNittolo Add an entry in the Galaxy FAQ using these screenshots. Call it "Structural workflow stalled at second to last step (Create or Update Organism job failed)".

screen shot 2019-02-12 at 12 36 28

This gives an error that says this in the preview and in the bug report:

Fatal error: Exit code 1 () Traceback (most recent call last): File "/galaxy/tools/cpt2/galaxy-tools/tools/webapollo/create_or_update_organism.py", line 27, in org_cn = GuessOrg(args, wa) File "/galaxy/tools/cpt2/galaxy-tools/tools/webapollo/webapollo.py", line 437, in GuessOrg raise Exception("Organism Common Name not provided") Exception: Organism Common Name not provided

screen shot 2019-02-12 at 13 26 24

and this is because you failed to provide a name for the organism before running the workflow.

To fix this. Rerun the tool. Enter the appropriate organism name. Also, check yes for resume dependencies.

screen shot 2019-02-12 at 13 08 27 screen shot 2019-02-12 at 13 08 40

That's it unless @MoffMade has more to add.

jrr-cpt commented 5 years ago

New entry for FAQ: Converting gff3 of a genome with frameshifted genes into Genbank format fails

This usually fails when the genes (the tape measure chaperones) in Apollo were not annotated with the correct attributes [put in link to frameshift tutorial]. It can be corrected by adding the attribute tag 'frameshift' and value 'a' to both the genes, then retrieving the data again and re-running the gff3 to genbank tool.

Error looks like this in the Galaxy history: Dataset_error

Galaxy bug report looks like this:

Galaxy_error

Go back to genome in Apollo and edit information for BOTH pieces of frameshifted protein: Edit_info

If the attributes were not added (or did not save): No_attributes

Correct entry: Added_attributes

Now the tool successfully completes, and the frameshift features are properly merged: Successful_job

jrr-cpt commented 5 years ago

@ToniNittolo new entry for Galaxy FAQ

Title: PhageTerm broke on my data

When running a PhageTerm job, the job fails. We do not have a good fix for this problem, as we didn't write the PhageTerm tool (it is published here). A couple common errors, and a few possible solutions are given below.

Error 1: Error 1 Error 1 1

Error 2: Error 2 Error 2 2

Error 3 (related to using host genome in the optional input):

Error 3

Possible solutions: 1) Re-run PhageTerm in Galaxy, omitting an input for the optional parameters, including the corresponding paired-end reads and the host genome. 2) Re-open the genome in another place (Re-open FASTA sequence). Try running the job again. 3) It is possible that some phage genome data simply cannot be run through this tool in its current state. We are in communication with the authors to attempt to remedy the situation. If you have encountered a reproducible error when running PhageTerm on a particular dataset, please send us the information (cory.maughmer@tamu.edu) so that the developers can develop a fix for that specific problem.

jrr-cpt commented 5 years ago

First several entries are completed. Additional FAQ can be added as needed.