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

JOSS review: Consider including graphviz as dependency for installation documentation #89

Closed
huddlej opened this issue Nov 1, 2024 · 1 comment

Comments

@huddlej
Copy link
Contributor

huddlej commented Nov 1, 2024

Description

I really like that the --dag argument provides a simple wrapper around Snakemake’s own dot output. As I worked through the part of the Basic Use docs that show how to build a DAG with this argument, I had to install graphviz into the snk environment I had created.

This is a pretty minor (non-blocking) user experience point, but what if the graphviz dependency was included in the initial installation command in the docs like the following?

conda create -n snk bioconda::snk conda-forge:graphviz

Alternately, you could make graphviz a dependency of the snk Bioconda recipe and keep the docs in their current simpler form.

Motivated by openjournals/joss-reviews#7410

@Wytamma
Copy link
Owner

Wytamma commented Nov 16, 2024

Great Idea @huddlej! I've added graphviz as a dependancy on conda (bioconda/bioconda-recipes#52143).

@Wytamma Wytamma closed this as completed Nov 16, 2024
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