From ce41f5e5a2e9fa779d8a7b076b38d318f25e5e23 Mon Sep 17 00:00:00 2001 From: Saskia Hiltemann Date: Tue, 28 Nov 2023 12:27:18 +0100 Subject: [PATCH 1/3] add FAQ about how to ask for help with your analysis --- faqs/galaxy/analysis_getting_help.md | 38 ++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 faqs/galaxy/analysis_getting_help.md diff --git a/faqs/galaxy/analysis_getting_help.md b/faqs/galaxy/analysis_getting_help.md new file mode 100644 index 00000000000000..6ce325814044a1 --- /dev/null +++ b/faqs/galaxy/analysis_getting_help.md @@ -0,0 +1,38 @@ +--- +title: How can I do analysis X? - Getting help +area: analysis +box_type: tip +layout: faq +contributors: [shiltemann] +--- + +If you don't know how to perform a certain analysis, you can ask the Galaxy community for help. + +#### Where to ask + +The best places to ask your analysis questions are: + +- [Galaxy Help forum](https://help.galaxyproject.org) +- [GTN Matrix chat](https://matrix.to/#/#Galaxy-Training-Network_Lobby:gitter.im) + + +#### How to ask + +The more detail you provide, the more likely you are to get a good answer; provide information about: +- **Your data and experiment** e.g. "paired-end RNASeq, mouse, 16 triplicates, 2 timepoints", etc +- **Your goal and research question** e.g. "I want to detect diffentially expressed genes between these two groups and generate a volcano plot" +- **What you have already tried?** Do you already know which tools you want to use? Did you already try some but they didn't work? Why not? Did you find good papers describing something similiar to what you want to do? etc. +- **Which Galaxy are you using?** And if you have already tried some steps, please [share your Galaxy history via URL]({%link faqs/galaxy/histories_sharing.md %}) and provide this along with your question. +- **Examples** + - **Bad Question:** *"Help!!! How to perform metagenomics analysis. I need it urgent!"* + - **Good Question:** *"Hello everybody, I have 16S rRNA sequencing data from Illumina, it was paired-end with 150bp reads. I want to perform a taxonomy analysis similar to this paper (provide link). I have followed this GTN tutorial (provide link), but my data is different because (reason) . How can I adapt this step of the analysis for my data? I read about a tool called X, but I cannot find it in Galaxy. I am using Galaxy EU, and here is a link to my history. Any help would be greatly appreciated!"* + + +#### Before you ask +- Check the [Galaxy Help forum](https://help.galaxyproject.org/) to see if others have already asked a similar question before. +- [Search](https://training.galaxyproject.org/training-material/search2) the [GTN website](https://training.galaxyproject.org) for a tutorial that matches what you want to do, and work your way through that. Even if it doesn't doe exactly what you need, you usually learn a lot along the way that will help you adapt it to your own data. + +#### Be patient +Please remember that most of the people answering questions on Matrix chat and the help forum are **volunteers** from the community. They take time out of their busy days to help you. They may also be in a different time zone, so it may take some time to get answers. Please always be patient and kind to each other, and adhere to our [code of conduct](https://galaxyproject.org/community/coc/). + +If you have a question about an error you've encountered in Galaxy, please see our [troublshooting page]({% link faqs/galaxy/analysis_troubleshooting.md %}). From 833243725ac24fbb16bb67418cecea6feec2e98c Mon Sep 17 00:00:00 2001 From: Saskia Hiltemann Date: Tue, 28 Nov 2023 12:37:56 +0100 Subject: [PATCH 2/3] update link --- faqs/galaxy/analysis_getting_help.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/faqs/galaxy/analysis_getting_help.md b/faqs/galaxy/analysis_getting_help.md index 6ce325814044a1..ab735441e0fb15 100644 --- a/faqs/galaxy/analysis_getting_help.md +++ b/faqs/galaxy/analysis_getting_help.md @@ -30,7 +30,7 @@ The more detail you provide, the more likely you are to get a good answer; provi #### Before you ask - Check the [Galaxy Help forum](https://help.galaxyproject.org/) to see if others have already asked a similar question before. -- [Search](https://training.galaxyproject.org/training-material/search2) the [GTN website](https://training.galaxyproject.org) for a tutorial that matches what you want to do, and work your way through that. Even if it doesn't doe exactly what you need, you usually learn a lot along the way that will help you adapt it to your own data. +- [Search]({% link search2.html %}) the [GTN website](https://training.galaxyproject.org) for a tutorial that matches what you want to do, and work your way through that. Even if it doesn't doe exactly what you need, you usually learn a lot along the way that will help you adapt it to your own data. #### Be patient Please remember that most of the people answering questions on Matrix chat and the help forum are **volunteers** from the community. They take time out of their busy days to help you. They may also be in a different time zone, so it may take some time to get answers. Please always be patient and kind to each other, and adhere to our [code of conduct](https://galaxyproject.org/community/coc/). From 6053ab48874c4e9cc51a80fcc1e088a2010995b7 Mon Sep 17 00:00:00 2001 From: Saskia Hiltemann Date: Tue, 28 Nov 2023 12:52:59 +0100 Subject: [PATCH 3/3] tweak text --- faqs/galaxy/analysis_getting_help.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/faqs/galaxy/analysis_getting_help.md b/faqs/galaxy/analysis_getting_help.md index ab735441e0fb15..8d052fa0a096a4 100644 --- a/faqs/galaxy/analysis_getting_help.md +++ b/faqs/galaxy/analysis_getting_help.md @@ -15,10 +15,12 @@ The best places to ask your analysis questions are: - [Galaxy Help forum](https://help.galaxyproject.org) - [GTN Matrix chat](https://matrix.to/#/#Galaxy-Training-Network_Lobby:gitter.im) +**Note:** For questions about errors you've encountered in Galaxy, please see our [troubleshooting page]({% link faqs/galaxy/analysis_troubleshooting.md %}). + #### How to ask -The more detail you provide, the more likely you are to get a good answer; provide information about: +The more detail you provide, the better we can help you. Please provide information about: - **Your data and experiment** e.g. "paired-end RNASeq, mouse, 16 triplicates, 2 timepoints", etc - **Your goal and research question** e.g. "I want to detect diffentially expressed genes between these two groups and generate a volcano plot" - **What you have already tried?** Do you already know which tools you want to use? Did you already try some but they didn't work? Why not? Did you find good papers describing something similiar to what you want to do? etc. @@ -30,9 +32,9 @@ The more detail you provide, the more likely you are to get a good answer; provi #### Before you ask - Check the [Galaxy Help forum](https://help.galaxyproject.org/) to see if others have already asked a similar question before. -- [Search]({% link search2.html %}) the [GTN website](https://training.galaxyproject.org) for a tutorial that matches what you want to do, and work your way through that. Even if it doesn't doe exactly what you need, you usually learn a lot along the way that will help you adapt it to your own data. +- [Search]({% link search2.html %}) the [GTN website](https://training.galaxyproject.org) for a tutorial that matches what you want to do, and work your way through that. Even if it doesn't doe exactly what you need, you usually learn a lot along the way that will help you adapt it to your own data or research question. #### Be patient Please remember that most of the people answering questions on Matrix chat and the help forum are **volunteers** from the community. They take time out of their busy days to help you. They may also be in a different time zone, so it may take some time to get answers. Please always be patient and kind to each other, and adhere to our [code of conduct](https://galaxyproject.org/community/coc/). -If you have a question about an error you've encountered in Galaxy, please see our [troublshooting page]({% link faqs/galaxy/analysis_troubleshooting.md %}). +