Skip to content

Use @inheritParams for multiomics parameter documentation#19

Open
Copilot wants to merge 5 commits intoupdate_multiomics_docsfrom
copilot/update-documentation-multiomics-functions
Open

Use @inheritParams for multiomics parameter documentation#19
Copilot wants to merge 5 commits intoupdate_multiomics_docsfrom
copilot/update-documentation-multiomics-functions

Conversation

Copy link
Copy Markdown

Copilot AI commented Feb 13, 2026

Parameter descriptions for sobject, gtf, frag_files, and verbose were duplicated across multiomics functions.

Changes

  • Established inheritance chain: add_nucleosome_signal defines sobject (ATAC processing context); inherited by tss_enrichment, calc_frip, process_seurat_atac
  • Cross-function inheritance: merge_gex_atac inherits verbose from process_seurat_atac
  • Composite inheritance: add_atac_metadata inherits from multiple sources (annotate_atac for sobject/gtf, calc_frip for frag_files/verbose)

Example

Before:

#' @param sobject Seurat object containing ATAC data to be processed.
#' @param frag_files Named list of paths to fragment files...
#' @param verbose Logical indicating whether functions should produce detailed output...
calc_frip <- function(sobject, frag_files, verbose = FALSE) {...}

#' @param sobject Seurat object containing ATAC data to be processed.
#' @param verbose Logical indicating whether functions should produce detailed output...
process_seurat_atac <- function(sobject, verbose = FALSE) {...}

After:

#' @inheritParams add_nucleosome_signal
#' @param frag_files Named list of paths to fragment files...
#' @param verbose Logical indicating whether functions should produce detailed output...
calc_frip <- function(sobject, frag_files, verbose = FALSE) {...}

#' @inheritParams add_nucleosome_signal
#' @param verbose Logical indicating whether processing functions should produce detailed output...
process_seurat_atac <- function(sobject, verbose = FALSE) {...}

Reduces ~15 lines of duplicated documentation while maintaining identical generated .Rd files.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits February 13, 2026 17:36
Co-authored-by: MVesuviusC <5831817+MVesuviusC@users.noreply.github.com>
Co-authored-by: MVesuviusC <5831817+MVesuviusC@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for multiomics functions Complete roxygen2 documentation for multiomics functions Feb 13, 2026
Copilot AI requested a review from MVesuviusC February 13, 2026 17:39
@MVesuviusC MVesuviusC changed the base branch from master to update_multiomics_docs February 13, 2026 17:46
@MVesuviusC MVesuviusC marked this pull request as ready for review February 13, 2026 17:48
@MVesuviusC
Copy link
Copy Markdown
Collaborator

Where possible, you should use @inheritParams to avoid repetition of argument description text

Copilot AI and others added 2 commits February 13, 2026 17:59
Co-authored-by: MVesuviusC <5831817+MVesuviusC@users.noreply.github.com>
Co-authored-by: MVesuviusC <5831817+MVesuviusC@users.noreply.github.com>
Copilot AI changed the title Complete roxygen2 documentation for multiomics functions Use @inheritParams for multiomics parameter documentation Feb 13, 2026
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