R/data.R

#' @title A tiny F2 cross
#'
#' @description F2 intercross studying iron status in mice as described in
#' Grant et al. (2006) <doi:10.1002/hep.21233>
#'
#' @format a 'cross' object as described by R package qtl2 and
#' detailed at https://kbroman.org/qtl2/assets/vignettes/user_guide.html#data_file_format
#' and https://kbroman.org/qtl2/assets/vignettes/developer_guide.html

#' @source \url{https://kbroman.org/qtl2/pages/sampledata.html}
'tiny_F2_cross'

#' @title Allele probabilities for the tiny F2 cross
#'
#' @description Allele probabilities for the mice from
#' Grant et al. (2006) <doi:10.1002/hep.21233>
#'
#' @format a list of allele probablities as described at
#' https://kbroman.org/qtl2/assets/vignettes/user_guide.html#calculating_genotype_probabilities
#' and https://kbroman.org/qtl2/assets/vignettes/developer_guide.html

#' @source \url{https://kbroman.org/qtl2/pages/sampledata.html}
'tiny_F2_ap'

#' @title A tiny scan1var result from an F2 cross
#'
#' @description The result of running scan1var on 'tiny_F2_cross' and 'tiny_F2_'ap'
#'
#' @format a data.frame as described...todo
#'
#' @source \url{https://kbroman.org/qtl2/pages/sampledata.html}
'tiny_F2_s1v'

#' @title A tiny DO "cross"
#'
#' @description DO experiment in which white blood cell concentration (WBC)
#' and neutrophil concentration (NEUT) were measured, as described in
#' Gatti et al. (2014) <doi:10.1534/genetics.114.161844>
#'
#' @format a 'cross' object as described by R package qtl2 and
#' detailed at https://kbroman.org/qtl2/assets/vignettes/user_guide.html#data_file_format
#' and https://kbroman.org/qtl2/assets/vignettes/developer_guide.html

#' @source \url{https://kbroman.org/qtl2/pages/sampledata.html}
'tiny_DO_cross'

#' @title Allele probabilities for the tiny DO cross
#'
#' @description Allele probabilities for the mice from
#' Gatti et al. (2014) <doi:10.1534/genetics.114.161844>
#'
#' @format a list of allele probablities as described at
#' https://kbroman.org/qtl2/assets/vignettes/user_guide.html#calculating_genotype_probabilities
#' and https://kbroman.org/qtl2/assets/vignettes/developer_guide.html

#' @source \url{https://kbroman.org/qtl2/pages/sampledata.html}
'tiny_DO_ap'

#' @title A tiny scan1var result from a DO experiment
#'
#' @description The result of running scan1var on 'tiny_DO_cross' and 'tiny_DO_'ap'
#'
#' @format a data.frame as described...todo
#'
#' @source \url{https://kbroman.org/qtl2/pages/sampledata.html}
'tiny_DO_s1v'
rcorty/vqtl2 documentation built on May 8, 2019, 8:11 a.m.