Skip to content

Add hpaSearch() vignette and update documentation - #38

Merged
anhtr merged 1 commit into
develfrom
claude/hpa-search-xmlparse-vignettes-fl047v
Aug 5, 2026
Merged

anhtr merged 1 commit into
develfrom
claude/hpa-search-xmlparse-vignettes-fl047v

Conversation

@anhtr

@anhtr anhtr commented Aug 5, 2026

Copy link
Copy Markdown
Owner

Summary

This PR adds comprehensive documentation for the hpaSearch() function, including a new dedicated vignette and updates to existing quick-start and in-depth vignettes to cover the search functionality.

Key Changes

  • New vignette: Added h_HPAanalyze_case_search.Rmd - a detailed tutorial demonstrating how to use hpaSearch() to query the Human Protein Atlas API directly from R, including:

    • Simple gene name searches
    • Exact match filtering
    • Custom column selection
    • Advanced field queries using the HPA query syntax
    • Integration with other HPAanalyze functions (hpaVis, hpaXmlGet, etc.)
  • Updated quick-start vignette (a_HPAanalyze_quick_start.Rmd):

    • Added new section "Search HPA for genes of interest" introducing hpaSearch()
    • Added example showing basic usage and reference to the full tutorial
    • Added section on hpaXmlParse() for completeness
  • Updated in-depth vignette (b_HPAanalyze_indepth.Rmd):

    • Added new section "Searching HPA data" with code examples
    • Updated compatibility table with hpar package to include search functionality
    • Cross-referenced the new search vignette
  • Updated NEWS: Added entries documenting the new vignette and coverage of hpaSearch() and hpaXmlParse() in existing vignettes

Notable Details

  • The new vignette demonstrates practical use cases including CD marker discovery with complex field queries
  • Documentation emphasizes that hpaSearch() eliminates the need for manual browser-based searches and tsv file downloads
  • Examples show how search results integrate seamlessly with downstream HPAanalyze functions

https://claude.ai/code/session_01GxvQc6HtxL9eTGTdMkAru1

Adds an 8th tutorial vignette walking through hpaSearch() (simple
lookups, exact matching, column selection, advanced field queries, and
feeding results into hpaVis/hpaXml), and adds short hpaSearch() and
hpaXmlParse() sections to the quick-start and in-depth vignettes so
both new functions are discoverable from the main docs.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GxvQc6HtxL9eTGTdMkAru1
@anhtr
anhtr merged commit cfad11e into devel Aug 5, 2026
12 checks passed
@anhtr
anhtr deleted the claude/hpa-search-xmlparse-vignettes-fl047v branch August 5, 2026 21:25
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