Package: Pedixplorer 1.1.0

Louis Le Nézet

Pedixplorer: Pedigree Functions

Routines to handle family data with a Pedigree object. The initial purpose was to create correlation structures that describe family relationships such as kinship and identity-by-descent, which can be used to model family data in mixed effects models, such as in the coxme function. Also includes a tool for Pedigree drawing which is focused on producing compact layouts without intervention. Recent additions include utilities to trim the Pedigree object with various criteria, and kinship for the X chromosome.

Authors:Louis Le Nézet [aut, cre], Jason Sinnwell [aut], Terry Therneau [aut], Daniel Schaid [ctb], Elizabeth Atkinson [ctb], Louis Le Nezet [ctb]

Pedixplorer_1.1.0.tar.gz
Pedixplorer_1.1.0.zip(r-4.5)Pedixplorer_1.1.0.zip(r-4.4)Pedixplorer_1.1.0.zip(r-4.3)
Pedixplorer_1.1.0.tgz(r-4.4-any)Pedixplorer_1.1.0.tgz(r-4.3-any)
Pedixplorer_1.1.0.tar.gz(r-4.5-noble)Pedixplorer_1.1.0.tar.gz(r-4.4-noble)
Pedixplorer_1.1.0.tgz(r-4.4-emscripten)Pedixplorer_1.1.0.tgz(r-4.3-emscripten)
Pedixplorer.pdf |Pedixplorer.html
Pedixplorer/json (API)
NEWS

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

Peer review:

Bug tracker:https://github.com/louislelezet/pedixplorer/issues

Datasets:

On BioConductor:Pedixplorer-1.1.0(bioc 3.20)Pedixplorer-1.0.0(bioc 3.19)

bioconductor-package

97 exports 1.16 score 59 dependencies

Last updated 2 months agofrom:569e94fa11

Exports:affectedaffected<-alignancestorsanchor_to_factoras.data.frameas.listauto_hintavailavail<-best_hintbit_sizeborderborder<-circfuncodedadiddadid<-descendantsfamidfamid<-family_checkfillfill<-find_avail_affectedfind_avail_noninformfind_unavailablefix_parentsgenerate_aff_indsgenerate_bordergenerate_colorsgenerate_fillhintsHintshints<-horderhorder<-ibd_matrixidid<-id1id2is_disconnectedis_founderis_informativeis_parentis_valid_scalesisinfisinf<-kinkin<-kindepthkinshipmake_famidmcolsmcols<-min_dist_infmomidmomid<-na_to_lengthnorm_pednorm_relnum_childpedPedped_to_legdfped_to_plotdfped<-Pedigreeplotplot_fromdfpolyfunpolygonsrelRelrel_code_to_factorrel<-scalesScalesscales<-sexsex_to_factorsex<-showshrinkspousespouse<-statusstatus<-subsetsummaryunrelatedupd_famid_idusefuluseful_indsuseful<-vect_to_binary

Dependencies:BiocGenericsbriocallrclicolorspacecpp11crayondescdiffobjdigestdplyrevaluatefansifarverfsgenericsggplot2gluegtableisobandjsonlitelabelinglatticelifecyclemagrittrMASSMatrixmgcvmunsellnlmepillarpkgbuildpkgconfigpkgloadplyrpraiseprocessxpspurrrquadprogR6RColorBrewerRcpprematch2rlangrprojrootS4Vectorsscalesstringistringrtestthattibbletidyrtidyselectutf8vctrsviridisLitewaldowithr

Pedigree alignment details

Rendered frompedigree_alignment.Rmdusingknitr::rmarkdownon Jul 01 2024.

Last update: 2024-01-16
Started: 2024-01-16

Pedigree kinship() details

Rendered frompedigree_kinship.Rmdusingknitr::rmarkdownon Jul 01 2024.

Last update: 2024-01-16
Started: 2024-01-16

Pedigree object

Rendered frompedigree_object.Rmdusingknitr::rmarkdownon Jul 01 2024.

Last update: 2024-01-16
Started: 2024-01-16

Pedigree plotting details

Rendered frompedigree_plot.Rmdusingknitr::rmarkdownon Jul 01 2024.

Last update: 2024-01-16
Started: 2024-01-16

Pedixplorer tutorial

Rendered frompedigree.Rmdusingknitr::rmarkdownon Jul 01 2024.

Last update: 2024-01-30
Started: 2019-01-09

Readme and manuals

Help Manual

Help pageTopics
The Pedixplorer package for pedigree dataPedixplorer-package Pedixplorer
Align a Pedigree objectalign align,Pedigree-method
Alignment first routinealignped1
Alignment second routinealignped2
Alignment third routinealignped3
Alignment fourth routinealignped4
Anchor variable to ordered factoranchor_to_factor
Initial hint for a Pedigree alignmentauto_hint auto_hint,Pedigree-method
Best hint for a Pedigree alignmentbest_hint best_hint,Pedigree-method
Bit size of a Pedigreebit_size bit_size,character_OR_integer-method bit_size,Ped-method bit_size,Pedigree-method
Circular elementcircfun
Draw arcsdraw_arc
Draw a polygondraw_polygon
Draw segmentsdraw_segment
Draw textsdraw_text
Find the duplicate pairs of a subjectduporder
Exclude stray marry-insexclude_stray_marryin
Exclude unavailable foundersexclude_unavail_founders
Find single affected and available individual from a Pedigreefind_avail_affected find_avail_affected,Ped-method find_avail_affected,Pedigree-method
Find uninformative but available subjectfind_avail_noninform find_avail_noninform,Ped-method find_avail_noninform,Pedigree-method
Find unavailable subjects in a Pedigreefind_unavailable find_unavailable,Ped-method find_unavailable,Pedigree-method
Find the siblings of a subjectfindsibs
Find the spouse of a subjectfindspouse
Fix parents relationship and genderfix_parents fix_parents,character-method fix_parents,data.frame-method
Process the affection informationsgenerate_aff_inds
Process the border colors based on availabilitygenerate_border
Process the filling and border colors based on affection and availabilitygenerate_colors generate_colors,character-method generate_colors,numeric-method generate_colors,Pedigree-method
Process the filling colors based on affectiongenerate_fill
Get twin relationshipsget_twin_rel
Hints objectas.list,Hints-method Hints Hints,Hints,missing_OR_NULL-method Hints,list,missing_OR_NULL-method Hints,missing_OR_NULL,missing_OR_NULL-method Hints,numeric,data.frame-method Hints,numeric,missing_OR_NULL-method Hints-class horder horder,Hints-method horder<- horder<-,Hints-method spouse spouse,Hints-method spouse<-,Hints,data.frame-method subset,Hints-method
IBD matrixibd_matrix
Find informative individualsis_informative is_informative,character_OR_integer-method is_informative,Pedigree-method
Individual's depth in a pedigreekindepth kindepth,character_OR_integer-method kindepth,Ped-method kindepth,Pedigree-method
Kinship matrixkinship kinship,character-method kinship,Ped-method kinship,Pedigree-method
Compute family idmake_famid make_famid,character-method make_famid,Pedigree-method
Minimum distance to the informative individualsmin_dist_inf min_dist_inf,character-method min_dist_inf,Ped-method min_dist_inf,Pedigree-method
Minnesota Breast Cancer Studyminnbreast
Normalise a Ped object dataframenorm_ped
Normalise a Rel object dataframenorm_rel
Number of childsnum_child num_child,character_OR_integer-method num_child,Pedigree-method
Create plotting legend data frame from a Pedigreeped_to_legdf ped_to_legdf,Pedigree-method
Create plotting data frame from a Pedigreeped_to_plotdf ped_to_plotdf,Pedigree-method
Ped objectaffected affected,Ped-method affected<- affected<-,Ped,numeric_OR_logical-method as.data.frame,Ped-method as.list,Ped-method avail avail,Ped-method avail<- avail<-,Ped,numeric_OR_logical-method dadid dadid,Ped-method dadid<- dadid<-,Ped,character_OR_integer-method famid famid,Ped-method famid<- famid<-,Ped,character_OR_integer-method id id,Ped-method id<- id<-,Ped,character_OR_integer-method isinf isinf,Ped-method isinf<- isinf<-,Ped,numeric_OR_logical-method kin kin,Ped-method kin<- kin<-,Ped,numeric-method mcols<-,Ped,data.frame-method mcols<-,Ped,list-method momid momid,Ped-method momid<- momid<-,Ped,character_OR_integer-method Ped Ped,character_OR_integer-method Ped,data.frame-method Ped,missing-method Ped-class sex sex,Ped-method sex<- sex<-,Ped,character_OR_integer-method show,Ped-method status status,Ped-method status<- status<-,Ped,numeric_OR_logical-method subset,Ped-method summary,Ped-method useful useful,Ped-method useful<- useful<-,Ped,numeric_OR_logical-method
Pedigree objectas.list,Pedigree-method border,Pedigree-method border<-,Pedigree,data.frame-method famid,Pedigree-method fill,Pedigree-method fill<-,Pedigree,data.frame-method hints hints,Pedigree-method hints<- hints<-,Pedigree,Hints-method horder,Pedigree-method horder<-,Pedigree-method length,Pedigree-method mcols,Pedigree-method mcols<-,Pedigree,ANY-method ped ped,Pedigree,ANY-method ped,Pedigree,missing-method ped<- ped<-,Pedigree,ANY,ANY-method ped<-,Pedigree,missing,Ped-method Pedigree Pedigree,character_OR_integer-method Pedigree,data.frame-method Pedigree,missing-method Pedigree-class rel rel,Pedigree,ANY-method rel,Pedigree,missing-method rel<- rel<-,Pedigree,ANY,ANY-method rel<-,Pedigree,missing,Rel-method scales scales,Pedigree-method scales<- scales<-,Pedigree,Scales-method show,Pedigree-method spouse,Pedigree-method spouse<- spouse<-,Pedigree,data.frame-method subset,Pedigree-method summary,Pedigree-method [,Pedigree,ANY,missing,ANY-method
Generate all possible permutationpermute
Create a plot from a data.frameplot_fromdf
Plot Pedigreesplot,Pedigree plot,Pedigree,missing-method plot.Pedigree
Polygonal elementpolyfun
List of polygonal elementspolygons
Relationship code variable to ordered factorrel_code_to_factor
Rel objectas.data.frame,Rel-method as.list,Rel-method code code,Rel-method famid,Rel-method famid<-,Rel,character_OR_integer-method id1 id1,Rel-method id2 id2,Rel-method Rel Rel,character_OR_integer-method Rel,data.frame-method Rel,missing-method Rel-class show,Rel-method subset,Rel-method summary,Rel-method
Sampleped datasampleped
Scales objectas.list,Scales-method border border,Scales-method border<- border<-,Scales,data.frame-method fill fill,Scales-method fill<- fill<-,Scales,data.frame-method Scales Scales,data.frame,data.frame-method Scales,missing,missing-method Scales-class
Set plotting areaset_plot_area
Gender variable to ordered factorsex_to_factor
Shift set of siblings to the left or rightshift
Shrink Pedigree objectshrink shrink,Ped-method shrink,Pedigree-method
Subset a region of a Pedigreesubregion
Find Unrelated subjectsunrelated unrelated,Ped-method unrelated,Pedigree-method
Update family prefix in individuals idupd_famid_id upd_famid_id,character,ANY-method upd_famid_id,Ped,character_OR_integer-method upd_famid_id,Ped,missing-method upd_famid_id,Pedigree,character_OR_integer-method upd_famid_id,Pedigree,missing-method upd_famid_id,Rel,character_OR_integer-method upd_famid_id,Rel,missing-method
Usefulness of individualsuseful_inds useful_inds,character-method useful_inds,Ped-method useful_inds,Pedigree-method
Vector variable to binary vectorvect_to_binary