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

hicBuildMatrix SAM inputs changed from repeat to plain params #6670

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

pavanvidem
Copy link
Member

FOR CONTRIBUTOR:

  • I have read the CONTRIBUTING.md document and this tool is appropriate for the tools-iuc repo.
  • License permits unrestricted use (educational + commercial)
  • This PR adds a new tool or tool collection
  • This PR updates an existing tool or tool collection
  • This PR does something else (explain below)

A repeat with exactly 2 params can be replaced with two params. With two params, at least the labels are better.

version bump only for the affected tools.

@bgruening
Copy link
Member

@joachimwolff does this look good to you?

@@ -32,7 +29,7 @@
#if $dbKey:
--genomeAssembly '$dbKey'
#else
--genomeAssembly '$samFiles[0].samFile.metadata.dbkey'
--genomeAssembly '$samFile1.metadata.dbkey'
Copy link
Contributor

Choose a reason for hiding this comment

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

We should add a unspecified_build validator to both inputs.

@@ -47,6 +47,11 @@
<param argument='--dpi' type='integer' optional='true' min="10" max="1000" label='DPI for image' help='Change the default resolution of the plot.' />
</xml>

<xml name="samFiles">
<param name="samFile1" type="data" format="sam,qname_input_sorted.bam" label="Forward SAM/BAM file to process" help="Please use the special BAM datatype: qname_input_sorted.bam and use for 'bowtie2' the '--reorder' option to create a BAM file."/>
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably you want unsorted.bam instead of qname_input_sorted.bam. unsorted.bam will allow any bam file.

Copy link
Contributor

Choose a reason for hiding this comment

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

Please do not change this behavior at all. You would need to change the behavior of the according mappers, and test if the unsorted type hicBuildMatrix still works under all unsorted scenarios.

Copy link
Contributor

Choose a reason for hiding this comment

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

OK. Was just wondering, because sam has to be assumed unsorted. But I guess this is treated in the command block (if so analogous changes could be done for the other bam types).

@joachimwolff
Copy link
Contributor

@joachimwolff does this look good to you?

Ok for me. May I ask, what is the intention of making this cosmetic change?

@pavanvidem
Copy link
Member Author

@joachimwolff does this look good to you?

Ok for me. May I ask, what is the intention of making this cosmetic change?

@bgruening was going through some very old issues and we thought the old labeling which is "forward/reverse" was causing confusion to the users. Anyways, it should not change the tool behavior and the tool form will be a bit cleaner without unused repeats.

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.

4 participants