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

Create function dependency map #26

Open
6 tasks
jananiravi opened this issue Oct 2, 2024 · 17 comments
Open
6 tasks

Create function dependency map #26

jananiravi opened this issue Oct 2, 2024 · 17 comments
Assignees
Labels
documentation Improvements or additions to documentation, incl. R docstring/roxygen2 outreachy for outreachy interns package R package dev

Comments

@jananiravi
Copy link
Member

Create function dependency map for MolEvolvR

@jananiravi jananiravi added the outreachy for outreachy interns label Oct 2, 2024
@SunSummoner
Copy link
Collaborator

@jananiravi I wanted to clarify that I have to tag the functions, find out dependencies and create a function dependency map network. Is there anything more or anything I got wrong?

@akwe-afriitech
Copy link
Collaborator

Hi @jananiravi , would it be possible for me to be assigned to this task as well?

@jananiravi
Copy link
Member Author

Yes, @akwe-afriitech, check in with @SunSummoner's status and you can start contributing to this.

@akwe-afriitech
Copy link
Collaborator

akwe-afriitech commented Oct 3, 2024

hey @SunSummoner, please what is your current statues on the tasks, so far i have being able to list all the functions, Identified the user-facing functions, Identified the internal use functions
and built a table for dependency directionality, i am currently working on the function map.

@SunSummoner
Copy link
Collaborator

Hi @akwe-afriitech That sounds great! I have been working on tagging the both the types of functions. Have you done some work on that?

@Seyi007
Copy link
Collaborator

Seyi007 commented Oct 4, 2024

Hi @SunSummoner @akwe-afriitech, I've made some suggestions for new and more descriptive function names to be updated upon approval. Would this affect your dependency map? And you can find the list of potential new names in the #7 comments. Please let me know if you need any clarifications!

@akwe-afriitech
Copy link
Collaborator

Hello @SunSummoner, i had gone through all the R files and created a list of all the functions in them, i then wrote a function to convert all function names on the list from snake case and function names case to camel case, of cause it doesn't makes it fully descriptive but it was the quickest way to camel case. Here is what i currently have
Screenshot 2024-10-04 100215
The data is i json format, beacuse it was the most easily related from the conversion function which i wrote in JS. My R is still coming alone

Hello @Seyi007, yes that would indeed affect the function map, as the names would need to be change afterwards but thats ok, as soon as your suggestions are approve, an hour or 2 of work can fixed the function map

@Seyi007
Copy link
Collaborator

Seyi007 commented Oct 4, 2024

@akwe-afriitech Take a look at the comments in #7 , I've converted the names to camel cases and I've also replaced all occurrence of the old function names with the new ones in all files (.R and the others) in a forked branch, waiting for approval to create a pr. I suppose you're to work with the old name and new names by treating them as same (old -> new) to map the dependencies on these function, isn't it?

@jananiravi jananiravi added documentation Improvements or additions to documentation, incl. R docstring/roxygen2 package R package dev labels Oct 4, 2024
@SunSummoner
Copy link
Collaborator

Hey @akwe-afriitech its looks great. If you don't mind to share the data so I can create the graph using R. Otherwise I can make my list and match it with yours and the I can write the R script for the graph.

@akwe-afriitech
Copy link
Collaborator

sure here is the json file
function map.json

@akwe-afriitech
Copy link
Collaborator

akwe-afriitech commented Oct 4, 2024

Hello @SunSummoner please do take at this, i isolated all the fucntions with deppendencies and created a visual representation for them. Of cause i will still have to automate the process to work without manually adding the functions. Hoping to get pointers, were i am going wrong, or what to do better before proceeding

@akwe-afriitech
Copy link
Collaborator

Screenshot 2024-10-04 194601

@SunSummoner
Copy link
Collaborator

Hello @SunSummoner please do take at this, i isolated all the fucntions with deppendencies and created a visual representation for them. Of cause i will still have to automate the process to work without manually adding the functions. Hoping to get pointers, were i am going wrong, or what to do better before proceeding

Did you visualise it using R? Or the pictorically?

@SunSummoner
Copy link
Collaborator

Hello @SunSummoner please do take at this, i isolated all the fucntions with deppendencies and created a visual representation for them. Of cause i will still have to automate the process to work without manually adding the functions. Hoping to get pointers, were i am going wrong, or what to do better before proceeding

I am planning on working on it automating while coding for the function map.

@akwe-afriitech
Copy link
Collaborator

Hello @SunSummoner please do take at this, i isolated all the fucntions with deppendencies and created a visual representation for them. Of cause i will still have to automate the process to work without manually adding the functions. Hoping to get pointers, were i am going wrong, or what to do better before proceeding

Did you visualise it using R? Or the pictorically?

i visualised it using R, here is a picture of the code, attaching the code file to a branch of the forked project on my github repos
Screenshot 2024-10-05 133930

@jananiravi
Copy link
Member Author

jananiravi commented Oct 7, 2024

@SunSummoner @akwe-afriitech, just to check, are you finding the dependencies manually or automatically, e.g., pkgdepR, functiondepends, mvbutils, foodweb, etc.? they may not directly work as is, but worth checking a few options out (yet to look at your PR -- maybe it is automated)!

@SunSummoner
Copy link
Collaborator

SunSummoner commented Oct 7, 2024

@jananiravi I was doing it manually but using the packages you suggested is a better alternative.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation, incl. R docstring/roxygen2 outreachy for outreachy interns package R package dev
Projects
None yet
Development

No branches or pull requests

5 participants