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

rename importers to standardize "import" terminology #505

Merged
merged 25 commits into from
Apr 15, 2024

Conversation

thpralas
Copy link
Collaborator

rename following importers :

  • loadFromBiom --> importBIOM

  • loadFromQIIME2 --> importQIIME2

  • readQZA --> importQZA

  • loadfromMothur --> importMothur

  • loadFromMetaphlan --> importMetaphlan

  • loadFromHumann --> importHumann

Copy link
Contributor

@TuomasBorman TuomasBorman left a comment

Choose a reason for hiding this comment

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

SImilarly to other functions, add the olds function to deprecate.R

Also, I am thinking if importHumann and importMetaphlan should be importHUMAnN and importMetaPhlAn @antagomir

I think we should follow their naming convention even though it is harder to remember the correct naming. It is more clear that the function imports the HUMAnN data

Copy link
Contributor

@TuomasBorman TuomasBorman left a comment

Choose a reason for hiding this comment

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

Have run devtools::document()

It seems that yu have changed the name of importHUMAnN document but the file name is not updated in man folder

Copy link

codecov bot commented Apr 3, 2024

Codecov Report

Attention: Patch coverage is 43.90244% with 46 lines in your changes are missing coverage. Please review.

❗ No coverage uploaded for pull request base (devel@1d01162). Click here to learn what that means.

❗ Current head b91e221 differs from pull request most recent head a9e0921. Consider uploading reports for the commit a9e0921 to get more accurate results

Files Patch % Lines
R/deprecate.R 0.00% 18 Missing ⚠️
R/importMetaphlan.R 0.00% 10 Missing ⚠️
R/importHumann.R 25.00% 6 Missing ⚠️
R/importMothur.R 76.92% 6 Missing ⚠️
R/importQIIME2.R 45.45% 6 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##             devel     #505   +/-   ##
========================================
  Coverage         ?   72.82%           
========================================
  Files            ?       40           
  Lines            ?     4648           
  Branches         ?        0           
========================================
  Hits             ?     3385           
  Misses           ?     1263           
  Partials         ?        0           

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

Merge branch 'devel' of https://github.com/microbiome/mia into import_functions

# Conflicts:
#	NEWS
#	R/importMetaphlan.R
Copy link
Contributor

@TuomasBorman TuomasBorman left a comment

Choose a reason for hiding this comment

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

NEWS Outdated Show resolved Hide resolved
man/deprecate.Rd Outdated Show resolved Hide resolved
Copy link
Contributor

@TuomasBorman TuomasBorman left a comment

Choose a reason for hiding this comment

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

Change loadFromQZA to readQZA, then good to go

Copy link
Contributor

@TuomasBorman TuomasBorman left a comment

Choose a reason for hiding this comment

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

@antagomir
Copy link
Member

Ok to me when the above points are resolved.

@TuomasBorman TuomasBorman merged commit b7dd1c2 into devel Apr 15, 2024
3 checks passed
@TuomasBorman TuomasBorman deleted the import_functions branch April 15, 2024 12:05
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