Package: poolfstat 3.0.0

Mathieu Gautier

poolfstat: Computing f-Statistics and Building Admixture Graphs Based on Allele Count or Pool-Seq Read Count Data

Functions for the computation of F-, f- and D-statistics (e.g., Fst, hierarchical F-statistics, Patterson's F2, F3, F3*, F4 and D parameters) in population genomics studies from allele count or Pool-Seq read count data and for the fitting, building and visualization of admixture graphs. The package also includes several utilities to manipulate Pool-Seq data stored in standard format (e.g., such as 'vcf' files or 'rsync' files generated by the the 'PoPoolation' software) and perform conversion to alternative format (as used in the 'BayPass' and 'SelEstim' software). As of version 2.0, the package also includes utilities to manipulate standard allele count data (e.g., stored in TreeMix, BayPass and SelEstim format).

Authors:Mathieu Gautier [aut, cre]

poolfstat_3.0.0.tar.gz
poolfstat_3.0.0.tar.gz(r-4.5-noble)poolfstat_3.0.0.tar.gz(r-4.4-noble)
poolfstat_3.0.0.tgz(r-4.4-emscripten)poolfstat_3.0.0.tgz(r-4.3-emscripten)
poolfstat.pdf |poolfstat.html✨
poolfstat/json (API)

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

Peer review:

Uses libs:
  • c++– GNU Standard C++ Library v3

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

cpp

3.64 score 109 scripts 410 downloads 4 mentions 67 exports 77 dependencies

Last updated 2 days agofrom:1f444012ab. Checks:OK: 2. Indexed: no.

TargetResultDate
Doc / VignettesOKNov 25 2024
R-4.5-linux-x86_64OKNov 25 2024

Exports:.block_sum.block_sum2.compute_blockDdenom.compute_F3fromF2.compute_F3fromF2samples.compute_F4DfromF2samples.compute_F4fromF2.compute_F4fromF2samples.compute_H1.compute_Q2.compute_QmatfromF2samples.compute_snpFstAov.compute_snpHierFstAov.compute_snpQ1.compute_snpQ1onepop.compute_snpQ1rw.compute_snpQ2.compute_snpQ2onepair.compute_snpQ2rw.extract_allele_names.extract_nonvscan_counts.extract_vscan_counts.find_indelneighbor_idx.generateF3names.generateF4names.scan_allele_info.simureads_mono.simureads_polyadd.leafcompare.fitted.fstatscompute.f4ratiocompute.fstatscompute.pairwiseFSTcomputeFSTcountdata.subsetcountdata2genobaypassfind.tree.popsetfit.graphgenerate.graph.paramsgenerate.jackknife.blocksgenobaypass2countdatagenobaypass2pooldatagenoselestim2pooldatagenotreemix2countdatagraph.buildergraph.params2qpGraphFilesgraph.params2symbolic.fstatsheatmapis.countdatais.fitted.graphis.fstatsis.graph.paramsis.pairwisefstis.pooldatamake.example.filesplotplot_fstatspooldata.subsetpooldata2diyabcpooldata2genobaypasspooldata2genoselestimpopsync2pooldatarandomallele.pcarooted.njtree.buildersim.readcountssliding.windows.fstatvcf2pooldata

Dependencies:apebase64encbitbit64bslibcachemclicliprcodetoolscolorspacecpp11crayondata.tableDiagrammeRdigestdoParalleldplyrevaluatefansifarverfastmapfontawesomeforeachfsgenericsgluehighrhmshtmltoolshtmlwidgetsigraphiteratorsjquerylibjsonliteknitrlabelinglatticelifecyclemagrittrMatrixmemoisemimemunsellnlmennlspillarpkgconfigprettyunitsprogresspurrrR6rappdirsRColorBrewerRcppRcppProgressreadrrlangrmarkdownrstudioapiRyacassassscalesstringistringrtibbletidyrtidyselecttinytextzdbutf8vctrsviridisLitevisNetworkvroomwithrxfunyaml

poolfstatvignette

Rendered fromvignette.Rnwusingutils::Sweaveon Nov 25 2024.

Last update: 2021-05-27
Started: 2021-05-27

Readme and manuals

Help Manual

Help pageTopics
Test all possible connection of a leaf to a graph with non-admixed and or admixed edgesadd.leaf
bjack_covbjack_cov
block_sum.block_sum block_sum
block_sum2.block_sum2 block_sum2
Compare fitted f2, f3 and f4 f-statistics of an admixture graph with estimated onescompare.fitted.fstats
compute_blockDdenom.compute_blockDdenom compute_blockDdenom
compute_F3fromF2.compute_F3fromF2 compute_F3fromF2
compute_F3fromF2samples.compute_F3fromF2samples compute_F3fromF2samples
compute_F4DfromF2samples.compute_F4DfromF2samples compute_F4DfromF2samples
compute_F4fromF2.compute_F4fromF2 compute_F4fromF2
compute_F4fromF2samples.compute_F4fromF2samples compute_F4fromF2samples
compute_H1.compute_H1 compute_H1
compute_Q2.compute_Q2 compute_Q2
compute_QmatfromF2samples.compute_QmatfromF2samples compute_QmatfromF2samples
compute_snpFstAov.compute_snpFstAov compute_snpFstAov
compute_snpHierFstAov.compute_snpHierFstAov compute_snpHierFstAov
compute_snpQ1.compute_snpQ1 compute_snpQ1
compute_snpQ1onepop.compute_snpQ1onepop compute_snpQ1onepop
compute_snpQ1rw.compute_snpQ1rw compute_snpQ1rw
compute_snpQ2.compute_snpQ2 compute_snpQ2
compute_snpQ2onepair.compute_snpQ2onepair compute_snpQ2onepair
compute_snpQ2rw.compute_snpQ2rw compute_snpQ2rw
Compute F4ratio (estimation of admixture rate) from an fstats objectcompute.f4ratio
Estimate the F-statistics (F2, F3, F3star, F4, Dstat) and within and across population diversitycompute.fstats
Compute pairwise population population FST matrix (and possibly all pairwise SNP-specific FST)compute.pairwiseFST
Compute Fst from Pool-Seq data or Count datacomputeFST
S4 class to represent a Count data set.countdata countdata-class
Create a subset of a countdata object that contains count data as a function of pop or SNP indexescountdata.subset
Convert a countdata object into BayPass input files.countdata2genobaypass
extract_allele_names.extract_allele_names extract_allele_names
extract_nonvscan_counts.extract_nonvscan_counts extract_nonvscan_counts
extract_vscan_counts.extract_vscan_counts extract_vscan_counts
find_indelneighbor_idx.find_indelneighbor_idx find_indelneighbor_idx
Find sets of populations that may used as scaffold treefind.tree.popset
Estimate parameters of an admixture graphfit.graph
S4 class to represent a population tree or admixture graph and its underlying fitted parameter.fitted.graph fitted.graph-class gen.fitted.graph
S4 class to represent fstats results obtained with computeFstats.fstats fstats-class
Generate a graph parameter object to fit admixture graph to observed fstatsgenerate.graph.params
Generate block coordinates for block-jackknifegenerate.jackknife.blocks
generateF3names.generateF3names generateF3names
generateF4names.generateF4names generateF4names
Convert BayPass allele count input files into a coundata objectgenobaypass2countdata
Convert BayPass read count and haploid pool size input files into a pooldata objectgenobaypass2pooldata
Convert SelEstim read count input files into a pooldata objectgenoselestim2pooldata
Convert allele count input files from the Treemix program into a coundata objectgenotreemix2countdata
Implement a graph builder heuristic by successively adding leaves to an initial graphgraph.builder
S4 class to represent a population tree or admixture graph and its underlying parameter.graph.params graph.params-class
Generate files for the qpGraph software from a graph.params objectgraph.params2qpGraphFiles
Provide a symbolic representation of all the F-statistics and the model system of equationsgraph.params2symbolic.fstats
Show pairwisefst objectheatmap,pairwisefst-method
Check countdata objectsis.countdata
Check fitted.graph objectsis.fitted.graph
Check fstats objectsis.fstats
Check graph.params objectsis.graph.params
Check pairwisefst objectsis.pairwisefst
Check pooldata objectsis.pooldata
Create example filesmake.example.files
S4 class to represent a pairwise Fst results obtained with the compute.pairwiseFSTpairwisefst pairwisefst-class
Plot F2, F3, F3star, F4, D or pairwise Fst values with their Confidence Intervalsplot_fstats
plot pairwisefst objectplot,fitted.graph-method
plot fstats objectplot,fstats-method
plot graph in graph.params objectplot,graph.params-method
plot pairwisefst objectplot,pairwisefst-method
S4 class to represent a Pool-Seq data set.pooldata pooldata-class
Create a subset of the pooldata object that contains Pool-Seq data as a function of pool and/or SNP indexespooldata.subset
Convert a pooldata object into DIYABC input files.pooldata2diyabc
Convert a pooldata object into BayPass input files.pooldata2genobaypass
Convert a pooldata object into SelEstim input files.pooldata2genoselestim
poppair_idxpoppair_idx
Convert Popoolation Sync files into a pooldata objectpopsync2pooldata
PCA of a pooldata or countdata object using a random allele approachrandomallele.pca
Construct and root an Neighbor-Joining tree of presumably nonadmixed leavesrooted.njtree.builder
scan_allele_info.scan_allele_info scan_allele_info
Show countdata objectshow,countdata-method
Show fitted.graph objectshow,fitted.graph-method
Show fstats objectshow,fstats-method
Show graph.params objectshow,graph.params-method
Show pairwisefst objectshow,pairwisefst-method
Show pooldata objectshow,pooldata-method
Simulate read counts from count data and return a pooldata objectsim.readcounts
simureads_mono.simureads_mono simureads_mono
simureads_poly.simureads_poly simureads_poly
Compute sliding window estimates of F-statistics or ratio of F-statistics over the genomesliding.windows.fstat
Convert a VCF file into a pooldata object.vcf2pooldata