get_seed_oligos_df {scsR} | R Documentation

## get_seed_oligos_df

### Description

This function returns the screen, that is given in input, with additional columns about the possible off-targets/seed effect of each oligos. The seed effect is computed excluding the current oligo.

### Usage

    get_seed_oligos_df(screen, seedColName="seed7",  scoreColName="score", geneColName="GeneID", gene_interval = c(1,100),
                                     min_oligos_x_gene=4, min_oligos_x_statistics=4, random=FALSE, kolmogorovSampleSize=5000, progress_bar=FALSE )

### Arguments

`screen` | data frame containing the results of the siRNA experiment (sorted by significance).
`seedColName` | specify the direction of the sorting (from the lowest scores to the highest score or vice versa) (character vector)
`scoreColName` | name of the column that contains the score of the screen (character vector)
`geneColName` | name of the column that contains the names of the genes in the screen (character vector)
`gene_interval` | apply the analysis only to the genes that are included in this interval (the screen must be sorted by significance and the interval has to be intended from the best hits to the worst hits). (vector of integer)
`min_oligos_x_gene` | minimum number of oligos that a gene must have in order to be included in the analysis (integer)
`min_oligos_x_statistics` | minimum number of oligos with the same seed that is required in order to apply a statistics (otherwise 0 is returned). (integer)
`random` | randomize the genes of the screen (boolean)
`progress_bar` | print progress bar (boolean)
`kolmogorovSampleSize` | sample size to be used for the Kolmogorov Smirnov statistics (i.e. the number of genes that we consider to be enough in order to infer the correct distribution of the genome-wide screen. The higher this number, the slower the computation). If this variable is left to NULL the Kolmogorov statistics is disabled (integer)

### Value

screen, that is given in input, with additional columns about the possible off-targets/seed effect of each oligos. (data frame)

### Author(s)

Andrea Franceschini

### Examples

    	data(uuk_screen)

    	# to speed up the example we use only the first 100 rows
    	uuk_screen_reduced = uuk_screen[1:1000,]

    	uuk_screen <- add_seed(uuk_screen_reduced)
    	sodf = get_seed_oligos_df(uuk_screen)

[Package scsR version 1.20.0 Index]