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 compression option to export #114

Merged
merged 1 commit into from
Mar 2, 2022
Merged

Add compression option to export #114

merged 1 commit into from
Mar 2, 2022

Conversation

pinin4fjords
Copy link
Member

This PR makes the changes from #112 available via the command-line interface so we can actually leverage that direct compression in our Galaxy tools etc.

Copy link
Member

@pmb59 pmb59 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! But I would recommend @irisdianauy to give the final approval as she reviewed #112

"--mtx-compression",
"-G",
type=click.Choice(["zip", "gzip", "bz2", "zstd"]),
default=None,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should the default option be one of the compressed options?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's okay to have this set to None since the underlying function to generate the matrix accepts None (no compression) and will not return an error. But you're right that it might be a good idea feature-wise, if a compressed matrix is more commonly used directly downstream, e.g., direct downstream tools can accept compressed files (?).

Copy link
Member Author

@pinin4fjords pinin4fjords Mar 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pmb59 @irisdianauy Thanks for the feedback! As a general strategy we always try to add functionality in a way that doesn't change things by default, so we'll leave uncompressed as the option unless the user specifies otherwise. To do otherwise risks breaking the pipelines of anyone using these tools.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got that!

Copy link
Contributor

@irisdianauy irisdianauy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great as far as I can tell, if there are no more changes to the --G option default.

"--mtx-compression",
"-G",
type=click.Choice(["zip", "gzip", "bz2", "zstd"]),
default=None,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's okay to have this set to None since the underlying function to generate the matrix accepts None (no compression) and will not return an error. But you're right that it might be a good idea feature-wise, if a compressed matrix is more commonly used directly downstream, e.g., direct downstream tools can accept compressed files (?).

@pinin4fjords pinin4fjords merged commit e536933 into develop Mar 2, 2022
@pinin4fjords pinin4fjords deleted the feature/cli_gzip branch March 2, 2022 08:20
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

Successfully merging this pull request may close these issues.

3 participants