Skip to content
Snippets Groups Projects
Commit 0681a454 authored by ch19g17's avatar ch19g17
Browse files

Add two example datasets "snps" and "LDprofile" including relevant...

Add two example datasets "snps" and "LDprofile" including relevant documentation, and therefore adding R>=2.10 as a dependency
parent 8318fcd2
No related branches found
No related tags found
No related merge requests found
...@@ -7,6 +7,7 @@ Maintainer: Clare Horscroft <c.horscroft@soton.ac.uk> ...@@ -7,6 +7,7 @@ Maintainer: Clare Horscroft <c.horscroft@soton.ac.uk>
Description: A suite of statistics from the Zalpha family for identifying areas of the genome under selective pressure. Description: A suite of statistics from the Zalpha family for identifying areas of the genome under selective pressure.
License: MIT + file LICENSE License: MIT + file LICENSE
Encoding: UTF-8 Encoding: UTF-8
Depends: R (>= 2.10)
LazyData: true LazyData: true
RoxygenNote: 6.1.1 RoxygenNote: 6.1.1
Suggests: Suggests:
......
#' An example LD profile
#'
#' A simulated LD profile, containing example LD statisics for
#' genetic distances of 0 to 0.0049, in bins of size 0.0001.
#'
#' @docType data
#'
#' @usage data(LDprofile)
#'
#' @format A data frame with 50 rows and 5 variables:
#' \describe{
#' \item{bin}{the lower bound of each bin}
#' \item{rsq}{the expected rsq value for a pair of snps, where the genetic distance between them falls in the given bin}
#' \item{sd}{the standard deviation of the expected rsq value}
#' \item{Beta_a}{the first shape parameter for the Beta distribution fitted for this bin}
#' \item{Beta_b}{the second shape parameter for the Beta distribution fitted for this bin}
#' }
"LDprofile"
#' Details about some simulated SNPs
#'
#' A dataset containing the positions, genetic distances and
#' alleles for 20 SNPs, across 10 simulated chromosomes.
#'
#' @docType data
#'
#' @usage data(snps)
#'
#' @format A data frame with 20 rows and 12 variables:
#' \describe{
#' \item{positions}{location of the SNP on the chromosome}
#' \item{distances}{genetic distance of the SNP from the start of the chromosome}
#' \item{chrom_1}{allele of the SNP on the first example chromosome}
#' \item{chrom_2}{allele of the SNP on the second example chromosome}
#' \item{chrom_3}{allele of the SNP on the third example chromosome}
#' \item{chrom_4}{allele of the SNP on the fourth example chromosome}
#' \item{chrom_5}{allele of the SNP on the fifth example chromosome}
#' \item{chrom_6}{allele of the SNP on the sixth example chromosome}
#' \item{chrom_7}{allele of the SNP on the seventh example chromosome}
#' \item{chrom_8}{allele of the SNP on the eighth example chromosome}
#' \item{chrom_9}{allele of the SNP on the ninth example chromosome}
#' \item{chrom_10}{allele of the SNP on the tenth example chromosome}
#' }
"snps"
File added
File added
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/LDprofile-data.R
\docType{data}
\name{LDprofile}
\alias{LDprofile}
\title{An example LD profile}
\format{A data frame with 50 rows and 5 variables:
\describe{
\item{bin}{the lower bound of each bin}
\item{rsq}{the expected rsq value for a pair of snps, where the genetic distance between them falls in the given bin}
\item{sd}{the standard deviation of the expected rsq value}
\item{Beta_a}{the first shape parameter for the Beta distribution fitted for this bin}
\item{Beta_b}{the second shape parameter for the Beta distribution fitted for this bin}
}}
\usage{
data(LDprofile)
}
\description{
A simulated LD profile, containing example LD statisics for
genetic distances of 0 to 0.0049, in bins of size 0.0001.
}
\keyword{datasets}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/snps-data.R
\docType{data}
\name{snps}
\alias{snps}
\title{Details about some simulated SNPs}
\format{A data frame with 20 rows and 12 variables:
\describe{
\item{positions}{location of the SNP on the chromosome}
\item{distances}{genetic distance of the SNP from the start of the chromosome}
\item{chrom_1}{allele of the SNP on the first example chromosome}
\item{chrom_2}{allele of the SNP on the second example chromosome}
\item{chrom_3}{allele of the SNP on the third example chromosome}
\item{chrom_4}{allele of the SNP on the fourth example chromosome}
\item{chrom_5}{allele of the SNP on the fifth example chromosome}
\item{chrom_6}{allele of the SNP on the sixth example chromosome}
\item{chrom_7}{allele of the SNP on the seventh example chromosome}
\item{chrom_8}{allele of the SNP on the eighth example chromosome}
\item{chrom_9}{allele of the SNP on the ninth example chromosome}
\item{chrom_10}{allele of the SNP on the tenth example chromosome}
}}
\usage{
data(snps)
}
\description{
A dataset containing the positions, genetic distances and
alleles for 20 SNPs, across 10 simulated chromosomes.
}
\keyword{datasets}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment