Robust Ancestry Inference using Data Synthesis


[Up] [Top]

Documentation for package ‘RAIDS’ version 1.11.1

Help Pages

A B C D E F G I K L M N P R S T V W

-- A --

add1KG2SampleGDS Add the genotype information for the list of pruned SNVs into the Profile GDS file
addBlockFromDetFile Append information associated to ld blocks, as indexes, into the Population Reference SNV Annotation GDS file
addGeneBlockGDSRefAnnot Append information associated to blocks, as indexes, into the Population Reference SNV Annotation GDS file
addGeneBlockRefAnnot Append information associated to blocks, as indexes, into the Population Reference SNV Annotation GDS file
addGenotypeProfile Add the genotype information for the list of pruned SNVs into the Profile GDS file
addRef2GDS1KG Add the information about the unrelated patients to the Reference GDS file
addStudy1Kg Append information about the 1KG samples into the Profile GDS file
ancestryInferencePCAKNN Run most steps leading to the ancestry inference call based on PCA and KNN on a specific profile
anchorId Generic function for getting the anchorId slot in a class
anchorId-method A getter for the anchorId slot in a RAIDSparam class
anchorId<- Generic function for replacement of anchorId slot in a class
anchorId<--method Setter function for replacement of anchorId slot in a RAIDSparam class

-- B --

batch Generic function for getting the batch slot in a class
batch-method A getter for the batch slot in a RAIDSparam class
batch<- Generic function for replacement of batch slot in a class
batch<--method Setter function for replacement of batch slot in a RAIDSparam class
blockTypeId Generic function for getting the blockTypeId slot in a class
blockTypeId-method A getter for the blockTypeId slot in a RAIDSparam class
blockTypeId<- Generic function for replacement of blockTypeId slot in a class
blockTypeId<--method Setter function for replacement of blockTypeId slot in a RAIDSparam class

-- C --

CharacterOrNULL-class Class Union for character or NULL
chrInfo Generic function for getting the chrInfo slot in a class
chrInfo-method A getter for the chrInfo slot in a RAIDSparam class
chrInfo<- Generic function for replacement of chrInfo slot in a class
chrInfo<--method Setter function for replacement of chrInfo slot in a RAIDSparam class
cleanADMIXTUREFiles Generic function for getting the cleanADMIXTUREFiles slot in a class
cleanADMIXTUREFiles-method A getter for the cleanADMIXTUREFiles slot in a RAIDSparam class
cleanADMIXTUREFiles<- Generic function for replacement of cleanADMIXTUREFiles slot in a class
cleanADMIXTUREFiles<--method Setter function for replacement of cleanADMIXTUREFiles slot in a RAIDSparam class
computeAdmixtureProportions compute admixture proportion
computeAncestryFromSynthetic Select the optimal K and D parameters using the synthetic data and infer the ancestry of a specific profile
computeAncestryFromSynthetic2 Select the optimal K and D parameters using the synthetic data and infer the ancestry of a specific profile
computeAncestryFromSyntheticFile Select the optimal K and D parameters using the synthetic data and infer the ancestry of a specific profile
computeKNNRefSample Run a k-nearest neighbors analysis on one specific profile
computeKNNRefSyn Run a k-nearest neighbors analysis on a subset of the synthetic dataset
computeKNNRefSynthetic Run a k-nearest neighbors analysis on a subset of the synthetic dataset
computePCAMultiSynthetic Project synthetic profiles onto existing principal component axes generated using the reference 1KG profiles
computePCARefSample Project specified profile onto PCA axes generated using known reference profiles
computePoolSyntheticAncestryGr Run a PCA analysis and a K-nearest neighbors analysis on a small set of synthetic data using all 1KG profiles except the ones used to generate the synthetic profiles
computePoolSyntheticAncestryGr2 Run a PCA analysis and a K-nearest neighbors analysis on a small set of synthetic data using all 1KG profiles except the ones used to generate the synthetic profiles
computeSyntheticROC Calculate the AUROC of the inferences for specific values of D and K using the inferred ancestry results from the synthetic profiles.
createAccuracyGraph Generate accuracy graph
createAUROCGraph Generate accuracy graph
createStudy2GDS1KG Create the Profile GDS file(s) for one or multiple specific profiles using the information from a RDS Sample description file and the 1KG GDS file

-- D --

DataFrameOrNULL-class Class Union for data.frame or NULL
demoKnownSuperPop1KG The known super population ancestry of the demo 1KG reference profiles.
demoPCA1KG The PCA results of the demo 1KG reference dataset for demonstration purpose. Beware that the PCA has been run on a very small subset of the 1KG reference dataset and should not be used to call ancestry inference on a real profile.
demoPCASyntheticProfiles The PCA result of demo synthetic profiles projected on the demo subset 1KG reference PCA.
demoPedigreeEx1 The pedigree information about a demo profile called 'ex1'.

-- E --

eigenCount Generic function for getting the eigenCount slot in a class
eigenCount-method A getter for the eigenCount slot in a RAIDSparam class
eigenCount<- Generic function for replacement of eigenCount slot in a class
eigenCount<--method Setter function for replacement of eigenCount slot in a RAIDSparam class
eigenCountSyn Generic function for getting the eigenCountSyn slot in a class
eigenCountSyn-method A getter for the eigenCountSyn slot in a RAIDSparam class
eigenCountSyn<- Generic function for replacement of eigenCountSyn slot in a class
eigenCountSyn<--method Setter function for replacement of eigenCountSyn slot in a RAIDSparam class
estimateAllelicFraction Estimate the allelic fraction of the pruned SNVs for a specific profile

-- F --

fieldPopInfAnc Generic function for getting the fieldPopInfAnc slot in a class
fieldPopInfAnc-method A getter for the fieldPopInfAnc slot in a RAIDSparam class
fieldPopInfAnc<- Generic function for replacement of fieldPopInfAnc slot in a class
fieldPopInfAnc<--method Setter function for replacement of fieldPopInfAnc slot in a RAIDSparam class
fieldPopInRef Generic function for getting the fieldPopInRef slot in a class
fieldPopInRef-method A getter for the fieldPopInRef slot in a RAIDSparam class
fieldPopInRef<- Generic function for replacement of fieldPopInRef slot in a class
fieldPopInRef<--method Setter function for replacement of fieldPopInRef slot in a RAIDSparam class
fieldSubPop Generic function for getting the fieldSubPop slot in a class
fieldSubPop-method A getter for the fieldSubPop slot in a RAIDSparam class
fieldSubPop<- Generic function for replacement of fieldSubPop slot in a class
fieldSubPop<--method Setter function for replacement of fieldSubPop slot in a RAIDSparam class
fileReferenceAnnotGDS Generic function for getting the fileReferenceAnnotGDS slot in a class
fileReferenceAnnotGDS-method A getter for the fileReferenceAnnotGDS slot in a RAIDSparam class
fileReferenceAnnotGDS<- Generic function for replacement of fileReferenceAnnotGDS slot in a class
fileReferenceAnnotGDS<--method Setter function for replacement of fileReferenceAnnotGDS slot in a RAIDSparam class
fileReferenceGDS Generic function for getting the fileReferenceGDS slot in a class
fileReferenceGDS-method A getter for the fileReferenceGDS slot in a RAIDSparam class
fileReferenceGDS<- Generic function for replacement of fileReferenceGDS slot in a class
fileReferenceGDS<--method Setter function for replacement of fileReferenceGDS slot in a RAIDSparam class

-- G --

generateGDS1KG Generate the GDS file that will contain the information from Reference data set (reference data set)
generateMapSnvSel Generate the filter SNP information file in RDS format
generatePhase1KG2GDS Adding the phase information into the Reference GDS file
generatePhaseRef Adding the phase information into the Reference GDS file
generateVCF Generate a VCF with the information from the SNPs that pass a cut-off threshold
genome Generic function for getting the genome slot in a class
genome-method A getter for the genome slot in a RAIDSparam class
genoSource Generic function for getting the genoSource slot in a class
genoSource-method A getter for the genoSource slot in a RAIDSparam class
genoSource<- Generic function for replacement of genoSource slot in a class
genoSource<--method Setter function for replacement of genoSource slot in a RAIDSparam class
genoType Generic function for getting the genoType slot in a class
genoType-method A getter for the genoType slot in a RAIDSparam class
genoType<- Generic function for replacement of genoType slot in a class
genoType<--method Setter function for replacement of genoType slot in a RAIDSparam class
getMatrixPopSynthetic Generate a matrix of synthetic group per pop
getRef1KGPop Extract the specified column from the 1KG GDS 'sample.ref' node for the reference profiles (real ancestry assignation)
getRefSuperPop Extract the from the 1KG GDS 'sample.ref' node for the reference profiles (real ancestry assignation)
getRefSuperPop2 Extract the specified column from the 1KG GDS 'sample.ref' node for the reference profiles (real ancestry assignation)
groupChr1KGSNV Merge the genotyping files per chromosome into one file

-- I --

identifyRelative Identify genetically unrelated patients in GDS Reference file
identifyRelativeRef Identify genetically unrelated patients in GDS Reference file
inferAncestry Run most steps leading to the ancestry inference call on a specific DNA profile
inferAncestryDNA Run most steps leading to the ancestry inference call on a specific DNA profile (alias for inferAncestry )
inferAncestryGeneAware Run most steps leading to the ancestry inference call on a specific RNA profile
inferenceType Generic function for getting the inferenceType slot in a class
inferenceType-method A getter for the inferenceType slot in a RAIDSparam class
inferenceType<- Generic function for replacement of inferenceType slot in a class
inferenceType<--method Setter function for replacement of inferenceType slot in a RAIDSparam class

-- K --

kList Generic function for getting the kList slot in a class
kList-method A getter for the kList slot in a RAIDSparam class
kList<- Generic function for replacement of kList slot in a class
kList<--method Setter function for replacement of kList slot in a RAIDSparam class

-- L --

listPos Generic function for getting the listPos slot in a class
listPos-method A getter for the listPos slot in a RAIDSparam class
listPos<- Generic function for replacement of listPos slot in a class
listPos<--method Setter function for replacement of listPos slot in a RAIDSparam class

-- M --

matKNNSynthetic A small 'data.frame' containing the inferred ancestry on the synthetic profiles.
minCov Generic function for getting the minCov slot in a class
minCov-method A getter for the minCov slot in a RAIDSparam class
minCov<- Generic function for replacement of minCov slot in a class
minCov<--method Setter function for replacement of minCov slot in a RAIDSparam class
minProb Generic function for getting the minProb slot in a class
minProb-method A getter for the minProb slot in a RAIDSparam class
minProb<- Generic function for replacement of minProb slot in a class
minProb<--method Setter function for replacement of minProb slot in a RAIDSparam class

-- N --

nbSim Generic function for getting the nbSim slot in a class
nbSim-method A getter for the nbSim slot in a RAIDSparam class
nbSim<- Generic function for replacement of nbSim slot in a class
nbSim<--method Setter function for replacement of nbSim slot in a RAIDSparam class
np Generic function for getting the np slot in a class
np-method A getter for the np slot in a RAIDSparam class
np<- Generic function for replacement of np slot in a class
np<--method Setter function for replacement of np slot in a RAIDSparam class

-- P --

paramAncestry Generic function for getting the paramAncestry slot in a class
paramAncestry-method A getter for the paramAncestry slot in a RAIDSparam class
paramAncestry<- Generic function for replacement of paramAncestry slot in a class
paramAncestry<--method Setter function for replacement of paramAncestry slot in a RAIDSparam class
pathADMIXTURE Generic function for getting the pathADMIXTURE slot in a class
pathADMIXTURE-method A getter for the pathADMIXTURE slot in a RAIDSparam class
pathADMIXTURE<- Generic function for replacement of pathADMIXTURE slot in a class
pathADMIXTURE<--method Setter function for replacement of pathADMIXTURE slot in a RAIDSparam class
pathProfileGDS Generic function for getting the pathProfileGDS slot in a class
pathProfileGDS-method A getter for the pathProfileGDS slot in a RAIDSparam class
pathProfileGDS<- Generic function for replacement of pathProfileGDS slot in a class
pathProfileGDS<--method Setter function for replacement of pathProfileGDS slot in a RAIDSparam class
PCAalgorithm Generic function for getting the PCAalgorithm slot in a class
PCAalgorithm-method A getter for the PCAalgorithm slot in a RAIDSparam class
PCAalgorithm<- Generic function for replacement of PCAalgorithm slot in a class
PCAalgorithm<--method Setter function for replacement of PCAalgorithm slot in a RAIDSparam class
pcaList Generic function for getting the pcaList slot in a class
pcaList-method A getter for the pcaList slot in a RAIDSparam class
pcaList<- Generic function for replacement of pcaList slot in a class
pcaList<--method Setter function for replacement of pcaList slot in a RAIDSparam class
PCAmissingRate Generic function for getting the PCAmissingRate slot in a class
PCAmissingRate-method A getter for the PCAmissingRate slot in a RAIDSparam class
PCAmissingRate<- Generic function for replacement of PCAmissingRate slot in a class
PCAmissingRate<--method Setter function for replacement of PCAmissingRate slot in a RAIDSparam class
pedStudy Generic function for getting the pedStudy slot in a class
pedStudy-method A getter for the pedStudy slot in a RAIDSparam class
pedStudy<- Generic function for replacement of pedStudy slot in a class
pedStudy<--method Setter function for replacement of pedStudy slot in a RAIDSparam class
pedSynthetic A small 'data.frame' containing the information related to synthetic profiles. The ancestry of the profiles used to generate the synthetic profiles must be present.
phase Generic function for getting the phase slot in a class
phase-method A getter for the phase slot in a RAIDSparam class
phase<- Generic function for replacement of phase slot in a class
phase<--method Setter function for replacement of phase slot in a RAIDSparam class
phaseType Generic function for getting the phaseType slot in a class
phaseType-method A getter for the phaseType slot in a RAIDSparam class
phaseType<- Generic function for replacement of phaseType slot in a class
phaseType<--method Setter function for replacement of phaseType slot in a RAIDSparam class
posOffset Generic function for getting the posOffset slot in a class
posOffset-method A getter for the posOffset slot in a RAIDSparam class
posOffset<- Generic function for replacement of posOffset slot in a class
posOffset<--method Setter function for replacement of posOffset slot in a RAIDSparam class
pRecomb Generic function for getting the pRecomb slot in a class
pRecomb-method A getter for the pRecomb slot in a RAIDSparam class
pRecomb<- Generic function for replacement of pRecomb slot in a class
pRecomb<--method Setter function for replacement of pRecomb slot in a RAIDSparam class
prefix Generic function for getting the prefix slot in a class
prefix-method A getter for the prefix slot in a RAIDSparam class
prefix<- Generic function for replacement of prefix slot in a class
prefix<--method Setter function for replacement of prefix slot in a RAIDSparam class
prepPed1KG Prepare the pedigree file using pedigree information from Reference
prepPedSyntheticRef Extract the sample information from the 1KG GDS file for a list of profiles associated to a specific study in the Profile GDS file
prepPMatrix Generate the row for the ADMIXTURE P-matrix
prepSynthetic Add information related to the synthetic profiles (study and synthetic reference profiles information) into a Profile GDS file
profileFile Generic function for getting the profileFile slot in a class
profileFile-method A getter for the profileFile slot in a RAIDSparam class
profileFile<- Generic function for replacement of profileFile slot in a class
profileFile<--method Setter function for replacement of profileFile slot in a RAIDSparam class
profileGenoSynthesis Create the gds file for the profile with the genotype and synthetic data
pruningMethod Generic function for getting the pruningMethod slot in a class
pruningMethod-method A getter for the pruningMethod slot in a RAIDSparam class
pruningMethod<- Generic function for replacement of pruningMethod slot in a class
pruningMethod<--method Setter function for replacement of pruningMethod slot in a RAIDSparam class
pruningProfile2 Compute the list of pruned SNVs for a specific profile using the information from the Reference GDS file and a linkage disequilibrium analysis
pruningSample Compute the list of pruned SNVs for a specific profile using the information from the Reference GDS file and a linkage disequilibrium analysis

-- R --

RAIDSparam Create a RAIDSparam object
RAIDSparam-class An S4 class to represent the RAIDS parameters
reference Generic function for getting the reference slot in a class
reference-method A getter for the reference slot in a RAIDSparam class
reference<- Generic function for replacement of reference slot in a class
reference<--method Setter function for replacement of reference slot in a RAIDSparam class
runADMIXTURE Call ADMIXTURE
runExomeAncestry Run most steps leading to the ancestry inference call on a specific exome profile
runRNAAncestry Run most steps leading to the ancestry inference call on a specific RNA profile
runSynADMIXTURE run ADMIXTURE for the synthetic data

-- S --

sampleRef Generic function for getting the sampleRef slot in a class
sampleRef-method A getter for the inferenceType slot in a RAIDSparam class
sampleRef<- Generic function for replacement of sampleRef slot in a class
sampleRef<--method Setter function for replacement of sampleRef slot in a RAIDSparam class
seedADMIXTURE Generic function for getting the seedADMIXTURE slot in a class
seedADMIXTURE-method A getter for the seedADMIXTURE slot in a RAIDSparam class
seedADMIXTURE<- Generic function for replacement of seedADMIXTURE slot in a class
seedADMIXTURE<--method Setter function for replacement of seedADMIXTURE slot in a RAIDSparam class
select1KGPop Random selection of a specific number of reference profiles in each subcontinental population present in the 1KG GDS file
select1KGPopForSynthetic Random selection of a specific number of reference profiles in each subcontinental population present in the 1KG GDS file ( same as select1KGPop but the function doesn't need gds object as parameters but the file name of the referenceGDS )
selectForSynthetic Random selection of a specific number of reference profiles in each subcontinental population present in the refrence GDS file. ( call select1KGPopForSynthetic or selectHGDP1kgForSynthetic)
seqError Generic function for getting the seqError slot in a class
seqError-method A getter for the seqError slot in a RAIDSparam class
seqError<- Generic function for replacement of seqError slot in a class
seqError<--method Setter function for replacement of seqError slot in a RAIDSparam class
seqErrorSyn Generic function for getting the seqErrorSyn slot in a class
seqErrorSyn-method A getter for the seqErrorSyn slot in a RAIDSparam class
seqErrorSyn<- Generic function for replacement of seqErrorSyn slot in a class
seqErrorSyn<--method Setter function for replacement of seqErrorSyn slot in a RAIDSparam class
slideWindowMaxBP Generic function for getting the slideWindowMaxBP slot in a class
slideWindowMaxBP-method A getter for the slideWindowMaxBP slot in a RAIDSparam class
slideWindowMaxBP<- Generic function for replacement of slideWindowMaxBP slot in a class
slideWindowMaxBP<--method Setter function for replacement of slideWindowMaxBP slot in a RAIDSparam class
snpPositionDemo A small 'data.frame' containing the SNV information.
snvListVCF Generate a VCF with the information from the SNPs that pass a cut-off threshold
snvListVCFRef Generate a VCF with the information from the SNPs that pass a cut-off threshold
specificSNV Generic function for getting the specificSNV slot in a class
specificSNV-method A getter for the specificSNV slot in a RAIDSparam class
specificSNV<- Generic function for replacement of specificSNV slot in a class
specificSNV<--method Setter function for replacement of specificSNV slot in a RAIDSparam class
splitSelectByPop Group samples per subcontinental population
studyDF Generic function for getting the studyDF slot in a class
studyDF-method Getter for the studyDF slot in a RAIDSparam class
studyDF<- Generic function for replacement of studyDF slot in a class
studyDF<--method Replacement of studyDF slot in a 'RAIDSparam' object
studyDFSyn Generic function for getting the studyDFSyn slot in a class
studyDFSyn-method A getter for the studyDFSyn slot in a RAIDSparam class
studyDFSyn<- Generic function for replacement of studyDFSyn slot in a class
studyDFSyn<--method Replacement of studyDFSyn slot in a 'RAIDSparam' object
studyType Generic function for getting the studyType slot in a class
studyType-method A getter for the studyType slot in a RAIDSparam class
studyType<- Generic function for replacement of studyType slot in a class
studyType<--method Setter function for replacement of studyType slot in a RAIDSparam class
syntheticGeno Generate synthetic profiles for each cancer profile and 1KG reference profile combination and add them to the Profile GDS file
syntheticGeno2 Generate synthetic profiles for each cancer profile and 1KG reference profile combination and add them to the Profile GDS file
syntheticRefDF Generic function for getting the syntheticRefDF slot in a class
syntheticRefDF-method A getter for the syntheticRefDF slot in a RAIDSparam class
syntheticRefDF<- Generic function for replacement of syntheticRefDF slot in a class
syntheticRefDF<--method Setter function for replacement of syntheticRefDF slot in a RAIDSparam class

-- T --

thresholdLD Generic function for getting the thresholdLD slot in a class
thresholdLD-method A getter for the thresholdLD slot in a RAIDSparam class
thresholdLD<- Generic function for replacement of thresholdLD slot in a class
thresholdLD<--method Setter function for replacement of thresholdLD slot in a RAIDSparam class

-- V --

verbose Generic function for getting the verbose slot in a class
verbose-method A getter for the verbose slot in a RAIDSparam class
verbose<- Generic function for replacement of verbose slot in a class
verbose<--method Setter function for replacement of verbose slot in a RAIDSparam class

-- W --

writeBedProfile Generate a plink bed file TODO
writeBimPruned Generate a plink bim file
writeFamProfile Generate a plink fam file
writePMatrix Generate the row for the ADMIXTURE P-matrax