Skip to content

Recording/displaying metadata with EMMA#2

Merged
NajlaAbassi merged 94 commits into
develfrom
EMMAResult
May 19, 2026
Merged

Recording/displaying metadata with EMMA#2
NajlaAbassi merged 94 commits into
develfrom
EMMAResult

Conversation

@NajlaAbassi

@NajlaAbassi NajlaAbassi commented Apr 9, 2026

Copy link
Copy Markdown
Collaborator
  • EMMA_run() to capture info in a robust manner for:
    • common functions from clusterPro (5), gprofiler, mosdef (will expand later)
    • handle the case of custom functions
  • EMMA_show() to print a user friendly summary of the recorded metadata
  • EMMA_get_record() to fetch the corresponding attribute "EMMA_record"
  • EMMA_explain() to return human readable text with info recorded with EMMA_run() + pkg citations
  • Implementing EMMA_freeze()
  • Add EMMA_add_custom_metadata() to allow users to manually provide additional information
  • add tests and improve pkg coverage
  • update vignette to match the pkg state

@NajlaAbassi NajlaAbassi changed the title Recoding/displaying metadata with EMMA Recording/displaying metadata with EMMA Apr 10, 2026

@federicomarini federicomarini left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Well well well done!

See my few comments, I think we are very ready to go!
F

Comment thread .github/workflows/R-CMD-check.yaml Outdated
Comment thread data/universe.RData Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

wouldn't it be better to name this directly "gene_universe" or so to make it unambiguous/self explanatory?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

yes indeed! I'm renaming it now f5e8873

Comment thread inst/scripts/create_datasets_examples.R Outdated
Comment thread inst/scripts/create_datasets_examples.R Outdated
Comment thread R/EMMA-data.R Outdated
Comment thread R/EMMA_get_record.R
@@ -0,0 +1,25 @@
#' EMMA_get_record
#'
#' @param res Functional Enrichment Analysis results (enrichResult, gseaResult ...)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

especially for the reason of the "I want to know the packages and functions supported": Can we add a @Seealso (i think that is the tag) for linking to some other content on that line?

Comment thread R/EMMA_run.R Outdated
Comment thread tests/testthat/setuptests_EMMA.R
Comment thread vignettes/EMMA_workflow.png
Comment thread NEWS.md
@federicomarini

Copy link
Copy Markdown
Contributor

All good for me, I think!

@federicomarini federicomarini left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM ❤️

@federicomarini

Copy link
Copy Markdown
Contributor

I would say let's wrap it and let's submit!

@NajlaAbassi
NajlaAbassi merged commit 60f5d36 into devel May 19, 2026
0 of 8 checks passed
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.

2 participants