Package: WithinHostExperiment 0.99.2
WithinHostExperiment: Within-Host Pathogen Variant QC, Diversity, and Bottleneck
Provides a SummarizedExperiment-based container and workflow functions for analysing intra-host single nucleotide variants (iSNV) from pathogen deep sequencing data. Supports replicate-aware quality control with full provenance tracking, multi-caller import harmonisation, within-host diversity quantification, and standardised export to transmission bottleneck estimation tools. Designed as infrastructure that bridges upstream variant callers (iVar, LoFreq, Freebayes) with downstream analysis packages through a common data object with uncertainty-preserving QC.
Authors:
WithinHostExperiment_0.99.2.tar.gz
WithinHostExperiment_0.99.2.zip(r-4.7-any)WithinHostExperiment_0.99.2.zip(r-4.6-any)WithinHostExperiment_0.99.2.zip(r-4.5-any)
WithinHostExperiment_0.99.2.tgz(r-4.6-any)WithinHostExperiment_0.99.2.tgz(r-4.5-any)
WithinHostExperiment_0.99.2.tar.gz(r-4.7-any)WithinHostExperiment_0.99.2.tar.gz(r-4.6-any)
WithinHostExperiment_0.99.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
WithinHostExperiment/json (API)
| # Install 'WithinHostExperiment' in R: |
| install.packages('WithinHostExperiment', repos = c('https://bioc.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/cuiweig/withinhostexperiment/issues
- example_whe - Example WithinHostExperiment dataset
geneticsvariantannotationsequencinggenomicvariationqualitycontrolvariantdetectiondataimport
Last updated from:89c27e8b31. Checks:1 NOTE, 9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| bioc-checks | NOTE | 200 | ||
| linux-devel | OK | 472 | ||
| source / vignettes | OK | 563 | ||
| linux-release | OK | 552 | ||
| macos-release | OK | 546 | ||
| macos-oldrel | OK | 605 | ||
| windows-devel | OK | 515 | ||
| windows-release | OK | 500 | ||
| windows-oldrel | OK | 508 | ||
| wasm-release | OK | 133 |
Exports:adaptiveFilterannotateCodonChangeannotateGenesasViralBottleneckInputbenchmarkCallersbuildSFSbuildSFSListcalcCallerConcordancecalcDiversitycalcNeutralityTestscalcSharedVariantschao1ISNVcheckDiversityPlausibilitycombineColscombineRowscompareDiversitycompareSFSConcordanceRuleconsensusISNVconsensusSequencescorrectSFSBiasdetectCrossContaminationdetectEmergingVariantsestimateSelectionCoefficientexactBottleneckexportPairFrequenciesfitDiversityModelflagISNVflagPrimerSitesflagReplicateDiscordanceflagStrandBiasSCIflagTemporalInconsistencyfusFsISNVFiltermultitestCorrectionneutralityFromSFSpassedISNVpermutationTestpiISNVplotFrequencySpectrumplotFrequencyTrajectoryplotPairScatterplotQCDashboardplotSFSpNpSWithinHostqcFiltersqcFilters<-qcLogqcLog<-qcSummaryquickBottleneckreadWithinHostreadWithinHostTablesciStrandBiasshannonISNVshowsimpsonISNVtajimaDtrackFrequencytransmissionPairswattersonISNVWithinHostExperiment
Dependencies:abindAnnotationDbiaskpassBHBiobaseBiocBaseUtilsBiocGenericsBiocIOBiocParallelBiostringsbitbit64bitopsblobBSgenomecachemcigarilloclicodetoolscpp11crayoncurlDBIDelayedArrayfastmapformatRfutile.loggerfutile.optionsgenericsGenomeInfoDbGenomicAlignmentsGenomicFeaturesGenomicRangesgluehttrIRangesjsonliteKEGGRESTlambda.rlatticelifecycleMatrixMatrixGenericsmatrixStatsmemoisemimeopensslpkgconfigpngR6RCurlrestfulrRhtslibrjsonrlangRsamtoolsRSQLitertracklayerS4ArraysS4VectorsSeqinfosnowSparseArraySummarizedExperimentsysUCSC.utilsVariantAnnotationvctrsXMLXVectoryaml
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| WithinHostExperiment: Within-Host Pathogen Variant QC, Diversity, and Bottleneck | WithinHostExperiment-package |
| Create a technology-appropriate ISNVFilter | adaptiveFilter |
| Codon and amino acid consequence of each SNV | annotateCodonChange annotateCodonChange,WithinHostExperiment,ANY,character-method annotateCodonChange,WithinHostExperiment,ANY,XString-method annotateCodonChange,WithinHostExperiment,character,DNAStringSet-method annotateCodonChange,WithinHostExperiment,GRanges,DNAStringSet-method annotateCodonChange,WithinHostExperiment,GRangesList,DNAStringSet-method annotateCodonChange,WithinHostExperiment,TxDb,DNAStringSet-method |
| Label variant sites with the genes they overlap | annotateGenes annotateGenes,WithinHostExperiment,GRanges-method annotateGenes,WithinHostExperiment,TxDb-method |
| Export data for ViralBottleneck package | asViralBottleneckInput |
| Benchmark variant callers against truth or each other | benchmarkCallers |
| Build a site frequency spectrum from a WithinHostExperiment | buildSFS |
| Build SFS for all samples in a WithinHostExperiment | buildSFSList |
| Pairwise caller concordance matrix | calcCallerConcordance |
| Compute within-host diversity indices | calcDiversity calcDiversity,WithinHostExperiment-method |
| Compute neutrality test statistics | calcNeutralityTests calcNeutralityTests,WithinHostExperiment-method |
| Calculate shared variant statistics | calcSharedVariants |
| Chao1 richness estimator for iSNV data | chao1ISNV |
| Check diversity estimates against heuristic plausibility ranges | checkDiversityPlausibility |
| Convert between WithinHostExperiment, data.frame, VRanges and VCF | coerce,VCF,WithinHostExperiment-method coerce,VRanges,WithinHostExperiment-method coerce,WithinHostExperiment,data.frame-method coerce,WithinHostExperiment,VRanges-method coerce-WHE |
| Compare diversity between sample groups | compareDiversity |
| Compare two within-host SFS objects | compareSFS |
| Create a ConcordanceRule object | ConcordanceRule |
| ConcordanceRule: agreement required between technical replicates | .ConcordanceRule ConcordanceRule-class show,ConcordanceRule-method |
| Multi-caller consensus iSNV detection | consensusISNV |
| Consensus sequence of each sample | consensusSequences consensusSequences,WithinHostExperiment,character-method consensusSequences,WithinHostExperiment,DNAStringSet-method consensusSequences,WithinHostExperiment,XString-method |
| Correct ascertainment bias in the within-host SFS | correctSFSBias |
| Detect potential cross-contamination between samples | detectCrossContamination |
| Detect emerging variants across time points | detectEmergingVariants |
| Estimate selection coefficient from frequency trajectory | estimateSelectionCoefficient |
| Exact bottleneck size estimation | exactBottleneck |
| Example WithinHostExperiment dataset | example_whe |
| Export donor-recipient frequency table | exportPairFrequencies |
| Fit a linear model to diversity data | fitDiversityModel |
| Flag iSNV sites based on quality criteria | flagISNV flagISNV,WithinHostExperiment-method |
| Flag iSNVs in primer binding regions | flagPrimerSites |
| Flag iSNVs with replicate discordance | flagReplicateDiscordance |
| Flag strand-biased iSNVs using the SCI metric | flagStrandBiasSCI |
| Flag temporally inconsistent iSNVs in longitudinal data | flagTemporalInconsistency |
| Fu's Fs statistic | fusFs |
| Create an ISNVFilter object | ISNVFilter |
| ISNVFilter: Quality control filter for iSNV analysis | .ISNVFilter ISNVFilter-class show,ISNVFilter-method |
| Multiple testing correction for p-values | multitestCorrection |
| Compute all neutrality statistics from a WithinHostSFS | neutralityFromSFS |
| Permutation test for two-group comparison | permutationTest |
| Nucleotide diversity (pi) from iSNV frequencies | piISNV |
| Plot iSNV frequency spectrum | plotFrequencySpectrum |
| Plot allele frequency trajectories over time | plotFrequencyTrajectory |
| Plot donor-recipient frequency scatter | plotPairScatter |
| QC dashboard plot | plotQCDashboard |
| Plot a within-host site frequency spectrum | plotSFS |
| Within-host pN/pS ratio | pNpSWithinHost pNpSWithinHost,WithinHostExperiment,ANY,character-method pNpSWithinHost,WithinHostExperiment,ANY,XString-method pNpSWithinHost,WithinHostExperiment,character,DNAStringSet-method pNpSWithinHost,WithinHostExperiment,GRanges,DNAStringSet-method pNpSWithinHost,WithinHostExperiment,GRangesList,DNAStringSet-method pNpSWithinHost,WithinHostExperiment,TxDb,DNAStringSet-method |
| Access the QC audit log | passedISNV passedISNV,WithinHostExperiment-method qcFilters qcFilters,WithinHostExperiment-method qcFilters<- qcFilters<-,WithinHostExperiment-method qcLog qcLog,WithinHostExperiment-method qcLog<- qcLog<-,WithinHostExperiment-method transmissionPairs transmissionPairs,WithinHostExperiment-method |
| Generate a QC summary report | qcSummary |
| Quick bottleneck size estimation (beta-binomial approximate MLE) | quickBottleneck |
| Import iSNV data from VCF files | readWithinHost |
| Import iSNV data from tabular files | readWithinHostTable |
| Strand Coverage Imbalance (SCI) score | sciStrandBias |
| Shannon entropy from iSNV frequencies | shannonISNV |
| Simpson diversity index for iSNV frequencies | simpsonISNV |
| Tajima's D statistic | tajimaD |
| Track variant frequency trajectories over time | trackFrequency |
| Watterson's theta from iSNV count | wattersonISNV |
| Combine WithinHostExperiment objects by rows or columns | combineCols,WithinHostExperiment-method combineRows,WithinHostExperiment-method WHE-combine |
| Create a WithinHostExperiment from components | WithinHostExperiment |
| WithinHostExperiment: Container for within-host pathogen variant data | .WithinHostExperiment show,WithinHostExperiment-method WithinHostExperiment-class [,WithinHostExperiment,ANY,ANY,ANY-method |
| WithinHostSFS: Site Frequency Spectrum for within-host variants | .WithinHostSFS show,WithinHostSFS-method WithinHostSFS WithinHostSFS-class |
