Skip to content

Add DILI Discovery Proteomics vignette - #4

Merged
Rvirgenslane merged 87 commits into
mainfrom
copilot/add-dili-discovery-proteomics-vignette
May 9, 2026
Merged

Add DILI Discovery Proteomics vignette#4
Rvirgenslane merged 87 commits into
mainfrom
copilot/add-dili-discovery-proteomics-vignette

Conversation

Copilot AI commented May 5, 2026

Copy link
Copy Markdown
Contributor
  • Create vignettes/DILI_Hotgenes.Rmd based on data-raw/Build_DILI_Hotgenes.R
  • Run parallel validation and address review comments
  • Rename vignette 03 title to "Visualization, Exploration, and Enrichment"
  • Update cross-reference in vignette 01 to match vignette 04's current title
  • Add fgsea_() vs HotgeneSets() distinguishing note in vignette 05 overview
Original prompt

Create a new vignette for the Hotgenes package that documents the DILI (Drug-Induced Liver Injury) Discovery Proteomics analysis workflow based on the existing data-raw/Build_DILI_Hotgenes.R script.

Requirements:

  • Convert the Build_DILI_Hotgenes.R script into a comprehensive R Markdown vignette
  • Include all 12 analysis steps (data loading, filtering, normalization, modeling, contrasts, Hotgenes object creation)
  • Add context from the original publication (Federspiel et al. 2023, J Hepatol)
  • Document the MassIVE deposit ID (MSV000089782)
  • Include examples of downstream analyses using the resulting Hotgenes object (plots, GSEA, etc.)
  • Follow the format and style of the existing vignette (vignettes/Hotgenes.Rmd)
  • Include optional code for refreshing data directly from MassIVE
  • Add explanatory text about data limitations and methodology choices

The vignette should serve as both a reproducible example and educational material for users working with proteomics data and limma-based differential expression analysis in the Hotgenes framework.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: Hi I need a new vignette that needs to be part of this repo and package. It should be based on this script: @pfizer-opensource/Open-Hotgenes/files/data-raw/Build_DILI_Hotgenes.R

Assistant: I'll help you create a new vignette based on the Build_DILI_Hotgenes.R script. Let me first examine the repository structure to understand how vignettes are organized and the package structure.

Assistant: Now let me check the existing vignettes structure to understand the format:

Assistant: Now I'll create a comprehensive vignette based on the DILI Hotgenes build script. This vignette will document how to build the DILI (Drug-Induced Liver Injury) Hotgenes object from proteomics data.

Assistant: I've created a new vignette DILI_Hotgenes.Rmd for the Open-Hotgenes package based on the Build_DILI_Hotgenes.R script. Here's what the vignette includes:

Key Features:

  1. Clear Workflow Structure - All 12 steps from the script organized as executable sections with explanations

  2. Data Context - Detailed information about:

    • Original publication (Federspiel et al. 2023, J Hepatol)
    • MassIVE deposit ID (MSV000089782)
    • Important notes about private metadata limitations
  3. Processing Steps Documented:

    • Data loading from pre-parsed RDS
    • Sample column identification
    • Protein filtering (contaminants, UniProt reviews, min peptides)
    • VSN normalization
    • voomaByGroup transformation with Pool batch correction
    • Robust lmFit modeling
    • Contrast definitions (7 comparisons)
    • Hotgenes object creation
  4. Downstream Analysis Examples - Demonstrates how to use the resulting DILI Hotgenes object with:

    • Differential expression summaries
    • Volcano plots
    • Venn diagrams
    • Heatmaps
    • Expression plots
    • GSEA analysis
    • Interactive Shiny exploration
  5. Best Practices - Includes optional code for refreshing data directly from MassIVE

The vignette follows the same format and style as the existing Hotgenes.Rmd vignette and is ready to build with the package documentation system.

User: This needs to be a PR.

Assistant: I'm waiting for your confirmation on whether to proceed with creating the pull request. The tool is asking to verify the repository details and PR scope.

This pull request was created from Copilot chat.

Agent-Logs-Url: https://github.com/pfizer-opensource/Open-Hotgenes/sessions/637b665d-7f72-41b9-89f9-23e317a56479

Co-authored-by: Rvirgenslane <53314471+Rvirgenslane@users.noreply.github.com>
Copilot AI changed the title [WIP] Add vignette for DILI discovery proteomics analysis Add DILI Discovery Proteomics vignette May 5, 2026
Copilot AI requested a review from Rvirgenslane May 5, 2026 16:23
Copilot AI and others added 13 commits May 5, 2026 22:40
    - Fixed contrast_vectors arg to HotgenesDEseq2() bug that dropped contrast
      names from export.
    - Fixed HotgenesDEseq2() issue not supporting stat col generation for "ashr"
…nettes

Add four comprehensive Hotgenes vignettes
… support

- Uses shinytest2 + magick for 2x retina-quality captures
- Adaptive render waiting with stability detection
- Automatic retry logic (3 attempts)
- Professional annotations with cli logging
- Composite figure generation
- Full compliance with CSS STYLE_GUIDE (snake_case, cli messaging, if(FALSE) debug block, trailing-dash sections)
- Follows all naming conventions and documentation standards"
Rvirgenslane and others added 9 commits May 8, 2026 16:56
…organization

Reorganize vignettes by scope: Shiny prioritization, workflow GSEA in v03, and standalone HotgeneSets guide
…e-study-vignette

Remove DILI case-study vignette and clean vignette cross-references
@Rvirgenslane

Copy link
Copy Markdown
Collaborator

@copilot Please make three final editorial updates to improve vignette consistency:

Rename vignette 03 so its title better reflects the current scope, since it now includes not only visualization but also enrichment and gene-set configuration.
A good option would be:
“Visualization, Exploration, and Enrichment”

Update the reference to vignette 04 inside vignettes/01_Creating_Hotgenes_Objects.Rmd so it matches the current title.
Replace the outdated wording:

04 Interactive Exploration with Shiny
with the current title:

04 Using Shiny to Prioritize Genes of Interest
Clarify vignette 05 relative to fgsea_() with one short explanatory note in the overview or early in the vignette.
The goal is to distinguish:

fgsea_() in vignette 03 as enrichment from ranked DE results per contrast
HotgeneSets() in vignette 05 as sample-wise pathway activity scoring that returns a new Hotgenes object
A suggested sentence would be:

Unlike fgsea_(), which evaluates enrichment from ranked differential expression results for a contrast, HotgeneSets() computes pathway activity scores for each sample and returns a new Hotgenes object for downstream analysis.

Please keep the changes minimal.

…gnette 05 fgsea note

Agent-Logs-Url: https://github.com/pfizer-opensource/Open-Hotgenes/sessions/de266f18-eca6-4722-afa5-7d2cf957f099

Co-authored-by: Rvirgenslane <53314471+Rvirgenslane@users.noreply.github.com>

Copilot AI commented May 9, 2026

Copy link
Copy Markdown
Contributor Author

@copilot Please make three final editorial updates to improve vignette consistency:

Rename vignette 03 so its title better reflects the current scope, since it now includes not only visualization b...

Done in commit 48ded85:

  1. Vignette 03 — title updated to "Visualization, Exploration, and Enrichment" (both the YAML title: and %\VignetteIndexEntry{}).
  2. Vignette 01 — footer cross-reference updated to "04 Using Shiny to Prioritize Genes of Interest".
  3. Vignette 05 — added the distinguishing sentence to the Overview, right after the existing description of HotgeneSets().

Rvirgenslane and others added 13 commits May 8, 2026 18:05
…gnette-wording

Clarify Venn and GSEA follow-up views in Shiny vignette 04
…e-cross-navigation

[WIP] Update vignette cross-navigation for better usability
…avigation

README: add orientation sentence, TOC, and promote vignettes section to top
@Rvirgenslane
Rvirgenslane marked this pull request as ready for review May 9, 2026 02:02
@Rvirgenslane
Rvirgenslane merged commit dd926cc into main May 9, 2026
0 of 4 checks passed
@Rvirgenslane
Rvirgenslane deleted the copilot/add-dili-discovery-proteomics-vignette branch May 9, 2026 02:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants