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

Replace the function names in R/plotme.R #50

Closed
Seyi007 opened this issue Oct 6, 2024 · 3 comments · Fixed by #68
Closed

Replace the function names in R/plotme.R #50

Seyi007 opened this issue Oct 6, 2024 · 3 comments · Fixed by #68
Assignees
Labels
enhancement New feature or request outreachy for outreachy interns

Comments

@Seyi007
Copy link
Collaborator

Seyi007 commented Oct 6, 2024

          [R/plotme.R](https://github.com/JRaviLab/MolEvolvR/blob/main/R/plotme.R)
Original Modified User Facing
count_to_sunburst plotSunburst
count_to_treemap plotTreemap
create_all_col_params prepareColumnParams
create_one_col_params prepareSingleColumnParams
assert_count_df validateCountDF
all_non_n_cols_to_char .all_non_n_cols_to_char ✔️

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

All updates 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.

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

#notetoself @the-mayer, we need to figure out what these prepareXYZ functions are doing. The function names seem a bit vague.

@teddyCodex teddyCodex self-assigned this Oct 7, 2024
@teddyCodex
Copy link
Collaborator

teddyCodex commented Oct 7, 2024

#notetoself @the-mayer, we need to figure out what these prepareXYZ functions are doing. The function names seem a bit vague.

Not sure if this is helpful @jananiravi but all these functions (except all_non_n_cols_to_char) appear to be user-facing. They all appear in the NAMESPACE file.

create_all_col_params - appears to be designed to generate a set of parameters based on the columns in a data frame (count_data)
create_one_col_params - appears to processes a specific column (col_num) in a data frame (df) to generate parameters such as ids, parents, labels, values, and hovertext.

@the-mayer
Copy link
Collaborator

Just a note, eventually we will be reducing the number of exports for MolEvolvR.
Currently, it exports more functions than a user will be expected to use. Eventually this will be tackled in another series of issues.

At current, the NAMESPACE file is not the definitive source of truth for what will be exported in the release version of MolEvolvR .

@the-mayer the-mayer linked a pull request Oct 8, 2024 that will close this issue
11 tasks
the-mayer added a commit that referenced this issue Oct 8, 2024
Refactored function names in R/plotme.R
- fixes #50
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