Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add troubleshooting section to external instructions #690

Open
sjspielman opened this issue Feb 6, 2024 · 3 comments
Open

Add troubleshooting section to external instructions #690

sjspielman opened this issue Feb 6, 2024 · 3 comments

Comments

@sjspielman
Copy link
Member

sjspielman commented Feb 6, 2024

Also, it seems that the workflow always wants the -r version flag. If you try to run without one, it fails with the error:

Project `AlexsLemonade/scpca-nf` is currently stickied on revision: v0.7.2 -- you need to explicitly specify a revision with the option `-r` in order to use it

This error is not an always error. It has to do with what the last pulled version was. If you run nextflow pull without -r you should get the latest version and then be able to run it just fine. Which is to say that -r is not always required, but it is a often good idea.

Rather than adding -r everywhere, maybe we add a "troubleshooting" section? I would say if you see that error, try nextflow pull AlexsLemonade/scpca-nf to get the latest release, then try again. In general, I would rather have external users use the latest version unless they have a reason to stick with an old one.

Originally posted by @jashapiro in #688 (comment)


As quoted above, we may want a troubleshooting section which includes the "error" that users may encounter if they don't provide -r.

@allyhawkins
Copy link
Member

Just noting this original issue here. Although I don't know if any of the things from the original issue really need to be addressed anymore so I'm going to close the old one.

@allyhawkins
Copy link
Member

Maybe switching between docker and singularity would be the most helpful from that list.

@sjspielman
Copy link
Member Author

sjspielman commented Feb 6, 2024

🎢 from #690, just in case...

Some ideas to include right now would be:

  • how to clear the nextflow cache for the repo if trying to run an updated version
  • how to change the name of the queue used for your job scheduler (some places call it partition)
  • how to switch between docker and singularity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants