jack.knife.transform-methods: Jacknife Transformation

Description Usage Arguments Value Note Examples

Description

This generic function transforms an existing object of class "GENOME" into another object of class "GENOME", in which each region corresponds to the (JACKNIFE !) window. Each jacknife window will be excluded from the analyses and the calculation will be applied to the union of all other windows.

Usage

1
2
3
4
5
6
## S4 method for signature 'GENOME'
jack.knife.transform(object, 
	width=7, jump=5, 
	type=1,
	start.pos=FALSE,end.pos=FALSE
	)

Arguments

object

an object of class "GENOME"

width

window size. default:7

jump

jump size. default:5

type

1 scan only biallelic positions (SNPs), 2 scan the genome. default:1

start.pos

start position

end.pos

end position

Value

The function creates a transformed object of class "GENOME".

Note

This function currently is only available for SNP data formats. PopGenome will scan the data from position 1 to the last observed SNP if start or end-positions are not specified. This mechanism can also be applied to the splitting.data() function. Just set split.GENOME.class@jack.knife <- TRUE after splitting the data.

Examples

1
2
3
4
# GENOME.class      <- readData("...", format="VCF")
# jack.GENOME.class <- jack.knife.transform(GENOME.class,100,100)
# jack.GENOME.class <- neutrality.stats(jack.GENOME.class)
# jack.GENOME.class@Tajima.D

Example output

Loading required package: ff
Loading required package: bit
Attaching package bit
package:bit (c) 2008-2012 Jens Oehlschlaegel (GPL-2)
creators: bit bitwhich
coercion: as.logical as.integer as.bit as.bitwhich which
operator: ! & | xor != ==
querying: print length any all min max range sum summary
bit access: length<- [ [<- [[ [[<-
for more help type ?bit

Attaching package: 'bit'

The following object is masked from 'package:base':

    xor

Attaching package ff
- getOption("fftempdir")=="/work/tmp/tmp/RtmpZocMZn"

- getOption("ffextension")=="ff"

- getOption("ffdrop")==TRUE

- getOption("fffinonexit")==TRUE

- getOption("ffpagesize")==65536

- getOption("ffcaching")=="mmnoflush"  -- consider "ffeachflush" if your system stalls on large writes

- getOption("ffbatchbytes")==16777216 -- consider a different value for tuning your system

- getOption("ffmaxbytes")==536870912 -- consider a different value for tuning your system


Attaching package: 'ff'

The following objects are masked from 'package:bit':

    clone, clone.default, clone.list

The following objects are masked from 'package:utils':

    write.csv, write.csv2

The following objects are masked from 'package:base':

    is.factor, is.ordered

PopGenome documentation built on Feb. 1, 2020, 1:07 a.m.