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

feat: add tax_id parameter #147

Merged
merged 20 commits into from
Nov 15, 2023
Merged

feat: add tax_id parameter #147

merged 20 commits into from
Nov 15, 2023

Conversation

balajtimate
Copy link
Collaborator

Description

To have better control over the read orientation inference process, allow users to define the organism of the given sample, instead of inferring it. When the organism ID is given, the transcripts file is filtered based on that organism, and the filtered file is used for to infer the orientation.

  • Add parameter --org-id (int) to specify the taxonomy ID of the organism to map the reads against
  • Add function to find the short name belonging to the given org-id, to be reported in the results; if org-id is not found in transcript list, infer it
  • Add tests
  • Update README.md and .gitignore
  • Fix typo in get_read_layout.py and pylint config, remove unused option value 'C0330'
  • Replace .json method with .model_dump_json for Pydantic version >2 in htsinfer.py (in connection to fix: update Pydantic version #146)

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist

Please carefully read these items and tick them off if the statements are true
or do not apply.

  • I have performed a self-review of my own code
  • My code follows the existing coding style, lints and generates no new
    warnings
  • I have added type annotations to all function/method signatures, and I
    have added type annotations for any local variables that are non-trivial,
    potentially ambiguous or might otherwise benefit from explicit typing.
  • I have commented my code in hard-to-understand areas
  • I have added ["Google-style docstrings"] to all new modules, classes,
    methods/functions or updated previously existing ones
  • I have added tests that prove my fix is effective or that my feature
    works
  • New and existing unit tests pass locally with my changes and I have not
    reduced the code coverage relative to the previous state
  • I have updated any sections of the app's documentation that are affected
    by the proposed changes

If for some reason you are unable to tick off all boxes, please leave a
comment explaining the issue you are facing so that we can work on it
together.

Copy link

codecov bot commented Nov 10, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5ef3322) 100.00% compared to head (c8a10e6) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##               dev      #147   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        13           
  Lines         1078      1108   +30     
=========================================
+ Hits          1078      1108   +30     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@balajtimate balajtimate requested a review from uniqueg November 10, 2023 13:05
.gitignore Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
htsinfer/cli.py Outdated Show resolved Hide resolved
htsinfer/get_library_source.py Outdated Show resolved Hide resolved
htsinfer/get_library_source.py Outdated Show resolved Hide resolved
htsinfer/get_library_source.py Outdated Show resolved Hide resolved
htsinfer/get_library_source.py Outdated Show resolved Hide resolved
htsinfer/get_library_source.py Outdated Show resolved Hide resolved
htsinfer/get_library_source.py Outdated Show resolved Hide resolved
htsinfer/htsinfer.py Show resolved Hide resolved
@uniqueg uniqueg mentioned this pull request Nov 10, 2023
9 tasks
@balajtimate balajtimate requested a review from uniqueg November 14, 2023 16:56
@balajtimate balajtimate requested a review from uniqueg November 15, 2023 10:20
uniqueg
uniqueg previously approved these changes Nov 15, 2023
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

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

Okay, getting there. I already approve, because I don't think it will need another review - but please address those comments ;-)

htsinfer/exceptions.py Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
htsinfer/get_library_source.py Outdated Show resolved Hide resolved
htsinfer/get_library_source.py Show resolved Hide resolved
htsinfer/models.py Outdated Show resolved Hide resolved
@balajtimate balajtimate changed the title feat: add org_id parameter feat: add tax_id parameter Nov 15, 2023
@balajtimate balajtimate merged commit 8443c05 into dev Nov 15, 2023
19 checks passed
@balajtimate balajtimate deleted the add_org_param branch November 15, 2023 13:50
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