
Package index
Create the ScreenR object
Build the object from a count table and a barcode annotation, and update objects saved with older versions of ScreenR.
-
create_screenr_object() - Create a ScreenR object
-
screenr_object-classscreenr_object - The ScreenR object class
-
`assay<-`(<screenr_object>,<missing>)`assay<-`(<screenr_object>,<character>)`assay<-`(<screenr_object>,<numeric>)`assays<-`(<screenr_object>,<list>)`assays<-`(<screenr_object>,<SimpleList>)`rowData<-`(<screenr_object>)`colData<-`(<screenr_object>,<DataFrame>)`dimnames<-`(<screenr_object>,<list>) - Replacement Methods of a ScreenR Object
-
update_screenr_object() - Update a ScreenR object
-
remove_all_zero_row() - Remove the barcodes with zero counts in all samples
-
show(<screenr_object>) - Show a ScreenR object
-
`[`(<screenr_object>,<ANY>,<ANY>,<ANY>) - Subset a ScreenR object
-
get_annotation_table() - Get the annotation table
-
get_column_names() - Get the original column names
-
get_count_table() - Get the count table
-
get_data_table() - Get the data table
-
get_groups() - Get the groups
-
get_normalization() - Get the normalization
-
get_normalized_count_table() - Get the normalized count table
-
get_palettes()set_palettes() - Get or set the palettes of a ScreenR object
-
get_replicates() - Get the replicates
-
get_sample_table() - Get the sample table
-
set_annotation_table() - Set the annotation table
-
set_count_table() - Set the count table
-
set_data_table() - Set the data table
-
set_groups() - Set the groups
-
set_normalized_count_table() - Set the normalized count table
-
set_replicates() - Set the replicates
-
count_mapped_reads() - Get the mapped reads of each barcode in each sample
-
mapped_reads() - Compute the number of mapped reads of each sample
-
plot_mapped_reads() - Plot the number of mapped reads of each sample
-
plot_mapped_reads_distribution() - Plot the distribution of the mapped reads
-
barcode_lost() - Compute the number of barcodes lost in each sample
-
plot_barcode_lost() - Plot the number of barcodes lost in each sample
-
plot_barcode_lost_for_gene() - Plot the number of barcodes lost for each gene
-
compute_gini() - Compute the Gini index of each sample
-
plot_gini() - Plot the Gini index of each sample
-
plot_replicate_correlation() - Plot the correlation between samples
-
plot_mds() - Plot a multidimensional scaling of the samples
-
plot_pca() - Plot a principal component analysis of the samples
-
compute_explained_variance() - Compute the variance explained by the principal components
-
plot_explained_variance() - Plot the variance explained by the principal components
-
plot_boxplot() - Plot the normalized counts of genes in each sample
Normalization and barcode statistics
Normalize the counts and compute barcode-level fold changes and scores.
-
normalize_data() - Normalize the counts
-
compute_data_table() - Compute the data table
-
compute_metrics() - Compute the barcode metrics
-
compute_barcode_statistics() - Compute replicate-aware barcode statistics
-
create_design_matrix() - Create the design matrix
-
create_contrast() - Create a contrast
-
create_edger_obj() - Create an edgeR object
-
find_gene_zscore_hit() - Find hits with a gene-level Z-score test
-
plot_empirical_null() - Plot the empirical null of the gene statistics
-
find_camera_hit() - Find hits with CAMERA
-
find_roast_hit() - Find hits with ROAST or FRY
-
find_consistent_hit() - Find genes with a consistent directional effect across contrasts
-
combine_consistent_hits() - Combine evidence for an effect in every contrast
-
find_time_hit() - Find hits with a time-course model
-
summarise_hits() - Summarise the hits of several methods
-
plot_volcano() - Volcano plot of the genes
-
find_common_hit() - Find the hits in common between methods
-
plot_common_hit() - Plot the hits in common between methods
-
find_discordant_barcodes() - Find discordant barcodes
-
plot_barcode_hit() - Plot the barcodes of a gene (barcode plot)
-
plot_barcode_trend() - Plot the trend of the barcodes of genes over time
-
plot_trend() - Plot the trend of genes over time
-
plot_treatment_separation() - Plot the separation between two screening conditions
-
plot_barcode_heatmap() - Plot barcode abundance across samples
-
plot_zscore_distribution() - Plot the distribution of the barcode log2 fold changes
-
filter_by_slope() - Filter hits by the slope of their trend
-
filter_by_variance() - Filter hits by the variance of their barcodes
-
compute_slope() - Compute the slope of the trend of genes
CRISPR screens and reference genes
Choose the barcode thresholds for the library, check the screen with essential and non-essential reference genes, and correct CRISPR-Cas9 copy-number bias with CRISPRcleanR.
-
barcodes_per_gene() - Count the barcodes of each gene
-
compute_screen_quality() - Compute the quality of a screen from reference genes
-
plot_reference_separation() - Plot the separation of reference genes
-
scale_by_reference() - Scale scores to reference genes
-
correct_crispr_bias() - Correct CRISPR-Cas9 copy-number and proximity bias with CRISPRcleanR
-
crisprcleanr_available() - Is CRISPRcleanR Available
-
hart_reference_genes - Reference essential and non-essential human genes
-
run_screenr_app()screenr_app() - Analyse a screen in the browser with the ScreenR app
Legacy hit rules
Rules of earlier versions of ScreenR, kept for compatibility. They do not control the false discovery rate; use the tests above to call hits.
-
find_zscore_hit() - Find hits with the Z-score threshold rule
-
find_robust_zscore_hit() - Find hits with the robust Z-score threshold rule
Datasets
Example screen, a published K562 shRNA screen and a HAP1 CRISPR-Cas9 screen with known essential genes.
-
count_table - Example count table
-
annotation_table - Example annotation table
-
k562_count_table - K562 shRNA essentiality screen: count table
-
k562_annotation_table - K562 shRNA essentiality screen: annotation table
-
k562_reference_genes - K562 shRNA essentiality screen: reference essential and non-essential genes
-
hap1_count_table - HAP1 CRISPR-Cas9 knockout screen: count table
-
hap1_annotation_table - HAP1 CRISPR-Cas9 knockout screen: annotation table
-
ScreenR-packageScreenR - ScreenR: analysis of pooled shRNA and CRISPR-Cas9 screens