plot_screen_hits {scsR} | R Documentation

## plot_screen_hits

### Description

Gene-seed plot: plot the genes of the siRNA screen (x-axis) together with a representation of the effect of the seed of their oligos (circles). The position on the y-axis of the circles refers to the average score of the oligos of the gene that share the same seed. The dimension of the circles refers to the number of oligos that share the same seed in the screen (the higher the number of oligos with the same seed, the bigger is the circle). This graph can be used to look by eyes at the effect of the seeds on the genes.

### Usage

    plot_screen_hits(screen, output_file=NULL, geneScoreColName="median", 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,
                          ylab="score", xlab="gene", ylim=c(-4,4), graph_highest_count_thr=16, progress_bar=FALSE)

### Arguments

`screen` | data frame containing the results of the siRNA experiment.
`output_file` | 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)
`seedColName` | name of the column that contains the seeds of the siRNA sequences in the screen (character vector). (the sequences have to be provided in the guide/antisense orientation and each sequence must be in the format of a character vector, i.e. a simple string)
`geneScoreColName` | name of the column that contains the global scores of the genes (i.e. the column that contains the median or the average value of the oligos ) (character vector)
`gene_interval` | display in the graph only 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)
`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)
`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)
`ylab` | label of the graph y-axis (character vector)
`xlab` | label of the graph x-axis (character vector)
`ylim` | ylim of the graph (vector)
`graph_highest_count_thr` | maximum number of oligos to be used in order to display the largest circle in the graph (number)
`progress_bar` | whether to show a progress bar or not (Boolean)

### 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,]

    	screen = add_rank_col(add_seed(uuk_screen_reduced))
    	plot_screen_hits(screen)

    	# The screen has to be sorted. In our case it is already sorted via median.
    	# In order to sort the screen you can use our add_rank_col method
    	# example: arrange(add_rank_col(screen), median)

[Package scsR version 1.20.0 Index]