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 the listed function names in R/acc2lin.R #35

Closed
Seyi007 opened this issue Oct 5, 2024 · 4 comments · Fixed by #65
Closed

Rename the listed function names in R/acc2lin.R #35

Seyi007 opened this issue Oct 5, 2024 · 4 comments · Fixed by #65
Assignees
Labels
enhancement New feature or request outreachy for outreachy interns

Comments

@Seyi007
Copy link
Collaborator

Seyi007 commented Oct 5, 2024

         [R/acc2lin.R](https://github.com/JRaviLab/MolEvolvR/blob/main/R/acc2lin.R)
Original Modified User Facing
sink.reset sinkReset
add_lins addLineage
acc2lin acc2Lineage
efetch_ipg efetchIPG
ipg2lin IPG2Lineage

Originally posted by @the-mayer in #7 (comment)

All update should follow this format:

Original Modified User Facing
original_function newFunction

NOTE: Before beginning to work on a particular file, please check to see that @jananiravi has given the 👍 on the comment.

Please follow the contributing guidelines and create a new branch containing your changes. Commit your work, and submit a PR when ready for review.

Additionally, use the search in all files functionality in VS code, Rstudio, or any other text editor, and list all files the function is being called or used to be updated later.

@awasyn
Copy link
Collaborator

awasyn commented Oct 5, 2024

Can i work on this?

@Seyi007 Seyi007 added enhancement New feature or request outreachy for outreachy interns labels Oct 5, 2024
@jananiravi
Copy link
Member

made minor changes. Yes, go for it, @awasyn!

@awasyn
Copy link
Collaborator

awasyn commented Oct 7, 2024

I would like to suggest that we deprecate the functions and display update message instead of simply renaming them. I am assuming that these are functions already in use by user. @jananiravi

@awasyn awasyn mentioned this issue Oct 7, 2024
9 tasks
@jananiravi
Copy link
Member

This is a great suggestion in general, @awasyn! In this particular case, the repo is brand new and the only users are you (outreachy) and us! It's yet to go into widespread use. So for this instance, we plan to force-change the names and move on from there. In the future, once the package is in public use, depracation is the right way to go!
cc: @the-mayer

@the-mayer the-mayer linked a pull request Oct 8, 2024 that will close this issue
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request outreachy for outreachy interns
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants