Package: paramlink 1.1-5

Magnus Dehli Vigeland

paramlink: Parametric Linkage and Other Pedigree Analysis in R

NOTE: 'PARAMLINK' HAS BEEN SUPERSEDED BY THE 'PED SUITE' PACKAGES (<https://magnusdv.github.io/pedsuite/>). 'PARAMLINK' IS MAINTAINED ONLY FOR LEGACY PURPOSES AND SHOULD NOT BE USED IN NEW PROJECTS. A suite of tools for analysing pedigrees with marker data, including parametric linkage analysis, forensic computations, relatedness analysis and marker simulations. The core of the package is an implementation of the Elston-Stewart algorithm for pedigree likelihoods, extended to allow mutations as well as complex inbreeding. Features for linkage analysis include singlepoint LOD scores, power analysis, and multipoint analysis (the latter through a wrapper to the 'MERLIN' software). Forensic applications include exclusion probabilities, genotype distributions and conditional simulations. Data from the 'Familias' software can be imported and analysed in 'paramlink'. Finally, 'paramlink' offers many utility functions for creating, manipulating and plotting pedigrees with or without marker data (the actual plotting is done by the 'kinship2' package).

Authors:Magnus Dehli Vigeland [aut, cre], Thore Egeland [ctb], Guro Doerum [ctb]

paramlink_1.1-5.tar.gz
paramlink_1.1-5.zip(r-4.5)paramlink_1.1-5.zip(r-4.4)paramlink_1.1-5.zip(r-4.3)
paramlink_1.1-5.tgz(r-4.4-any)paramlink_1.1-5.tgz(r-4.3-any)
paramlink_1.1-5.tar.gz(r-4.5-noble)paramlink_1.1-5.tar.gz(r-4.4-noble)
paramlink_1.1-5.tgz(r-4.4-emscripten)paramlink_1.1-5.tgz(r-4.3-emscripten)
paramlink.pdf |paramlink.html
paramlink/json (API)
NEWS

# Install 'paramlink' in R:
install.packages('paramlink', repos = c('https://magnusdv.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/magnusdv/paramlink/issues

Datasets:
  • Xped - Example pedigree with X-linked disease pattern.
  • dominant - Example pedigree for linkage analysis
  • toyped - Toy pedigree for linkage analysis
  • twoloops - A consanguineous pedigree

On CRAN:

4.17 score 2 packages 49 scripts 352 downloads 1 mentions 93 exports 16 dependencies

Last updated 3 years agofrom:8f948b15bb. Checks:OK: 5 NOTE: 2. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 02 2024
R-4.5-winNOTENov 02 2024
R-4.5-linuxNOTENov 02 2024
R-4.4-winOKNov 02 2024
R-4.4-macOKNov 02 2024
R-4.3-winOKNov 02 2024
R-4.3-macOKNov 02 2024

Exports:addDaughteraddMarkeraddOffspringaddParentsaddSonallGenotypesancestorsbranchbreakLoopsconnectedComponentscousinPedcousinscousinsPeddescendantsdoubleCousinsdoubleFirstCousinsexamineKinshipsexclusionPowerFamilias2linkdatfast.gridfindLoopBreakersfindLoopBreakers2fullSibMatinggeno.grid.subsetgetMarkersgrandparentshalfCousinPedhalfCousinsPedhalfSibStackhasCAIBDestimateIBDtriangleinbreedingis.linkdatis.linkdat.listis.singletonjacquardjacquard2kinship_coefsleaveslikelihoodlikelihood_LINKAGElinkage.powerlinkageSimlinkdatlodlod.peaksLRmarkermarkerSimmendelianCheckmergePedmerlinmerlinUnlikelymodifyMarkermodifyMarkerMatrixnephews_niecesnuclearPedoffspringoneMarkerDistributionparentspeakSummarypedigreeLoopsplotPedListquadHalfFirstCousinsrandomPedreadDatfilereadFamiliasLocirelabelrelated.pairsrelationLRremoveIndividualsremoveMarkersrestore_linkdatsetAvailablesetMarkerssetModelsetPlotLabelsshowInTrianglesiblingssimpleSimsingletonspousesswapAffswapAvailableswapGenotypesswapSextieLoopstransferMarkerdatatrimtwoMarkerDistributionunrelatedwrite.linkdat

Dependencies:assertthatdigestevaluategenericshighrkinship2knitrlatticeMatrixmaxLikmiscToolsquadprogsandwichxfunyamlzoo

Readme and manuals

Help Manual

Help pageTopics
Genotype combinationsallGenotypes fast.grid geno.grid.subset
linkdat to data.frame conversionas.data.frame.linkdat
linkdat to matrix conversionas.matrix.linkdat restore_linkdat
Example pedigree for linkage analysisdominant
Check pedigree for relationship errorsexamineKinships
Power of exclusionexclusionPower
Convert 'Familias' output to linkdat objectsconnectedComponents Familias2linkdat readFamiliasLoci
Pairwise common ancestorshasCA
Relatedness estimationIBDestimate
IBD triangle plotIBDtriangle
Is an object a linkdat object?is.linkdat is.linkdat.list is.singleton
Pedigree likelihoodlikelihood likelihood.linkdat likelihood.list likelihood.singleton likelihood_LINKAGE
Power of a linkage studylinkage.power summary.powres
Simulate markers linked to a disease locus.linkageSim
Linkdat objectslinkdat print.linkdat singleton subset.linkdat summary.linkdat write.linkdat
S3 methods for class 'linkres'.as.data.frame.linkres linkres peakSummary plot.linkres print.linkres summary.linkres
Two-point LOD scorelod
LOD score peakslod.peaks
Likelihood ratios of pedigree hypothesesLR
Marker functionsaddMarker getMarkers marker markers modifyMarker modifyMarkerMatrix removeMarkers setMarkers swapGenotypes
Marker simulationmarkerSim
Check for Mendelian errorsmendelianCheck
Merge two pedigreesmergePed
MERLIN wrappersmerlin merlinUnlikely
Genotype probability distributiononeMarkerDistribution
Create simple pedigreescousinPed cousinsPed doubleCousins doubleFirstCousins fullSibMating halfCousinPed halfCousinsPed halfSibStack nuclearPed pedCreate quadHalfFirstCousins
Pedigree loopsbreakLoops findLoopBreakers findLoopBreakers2 pedigreeLoops tieLoops
Modify the pedigree of 'linkdat' objectsaddDaughter addOffspring addParents addSon branch pedModify relabel removeIndividuals swapAff swapSex trim
Pedigree subsetsancestors cousins descendants grandparents leaves nephews_nieces offspring parents pedParts related.pairs siblings spouses unrelated
Plot pedigrees with genotypesplot.linkdat plot.singleton
Plot a list of pedigrees.plotPedList
Random pedigreerandomPed
Read dat file in LINKAGE formatreadDatfile
Relatedness coefficientsinbreeding jacquard jacquard2 kinship_coefs relatednessCoeff
Relationship Likelihood RatiorelationLR
Functions for modifying availability vectorssetAvailable swapAvailable
Set, change or display the model parameters for 'linkdat' objectsprint.linkdat.model setModel
Attach plot labels to a linkdat objectsetPlotLabels
Add points to the IBD triangleshowInTriangle
Unconditional marker simulationsimpleSim
Toy pedigree for linkage analysistoyped
Transfer marker datatransferMarkerdata
A consanguineous pedigreetwoloops
Genotype probability distributiontwoMarkerDistribution
Example pedigree with X-linked disease pattern.Xped