Get dataframe with bootstrapped motif-summit distances
Source:R/get_df_distances_bootstrapped.R
get_df_distances_bootstrapped.RdWrapper for `MotifPeeker::bootstrap_distances` to get bootstrapped
motif-summit distances for given peaks and motifs, generating a
data.frame suitable for plots.
Arguments
- result
A
listwith the following elements:- peaks
A
listof peak files generated usingread_peak_file.- alignments
A
listof alignment files.- exp_type
A
charactervector of experiment types.- exp_labels
A
charactervector of experiment labels.- read_count
A
numericvector of read counts.- peak_count
A
numericvector of peak counts.
- user_motifs
A
listwith the following elements:- motifs
A
listof motif files.- motif_labels
A
charactervector of motif labels.
- genome_build
A character string with the abbreviated genome build name, or a BSGenome object. Check check_genome_build details for genome builds which can be imported as abbreviated names.
- samples_n
An integer specifying the number of bootstrap samples to generate. If
NULL, it is set to 70% of the number of peaks.- samples_len
An integer specifying the number of peaks to sample in each bootstrap iteration. If
NULL, it is set to 20 peaks.- out_dir
A
charactervector of output directory.- BPPARAM
A
BiocParallelParam-classobject enabling parallel execution. (default = SerialParam(), single-CPU run)
Following are two examples of how to set up parallel processing:BPPARAM = BiocParallel::MulticoreParam(4): Uses 4 CPU cores for parallel processing.library("BiocParallel")followed byregister(MulticoreParam(4))sets all subsequent BiocParallel functions to use 4 CPU cores.Motifpeeker()must be run withBPPARAM = BiocParallel::MulticoreParam().
IMPORTANT: For each worker, please ensure a minimum of 8GB of memory (RAM) is available as
motif_discoveryis memory-intensive.- meme_path
path to
meme/bin/(optional). Defaut:NULL, searches "MEME_PATH" environment variable or "meme_path" option for path to "meme/bin/".- verbose
A logical indicating whether to print verbose messages while running the function. (default = FALSE)
Value
A data.frame with the following columns:
- exp_label
Experiment labels.
- exp_type
Experiment types.
- motif_indice
Motif indices.
- bootstrap_iteration
Bootstrap iteration number.
- distance
Mean of absolute distances between peak summit and motif.
See also
Other generate data.frames:
get_df_distances(),
get_df_enrichment()
Examples
if (memes::meme_is_installed()) {
peak <- system.file("extdata", "CTCF_ChIP_peaks.narrowPeak",
package = "MotifPeeker") |>
read_peak_file() |>
sample(20)
motif_MA1102.3 <- system.file("extdata", "motif_MA1102.3.jaspar",
package = "MotifPeeker") |> read_motif_file()
motif_MA1930.2 <- system.file("extdata", "motif_MA1930.2.jaspar",
package = "MotifPeeker") |> read_motif_file()
input <- list(
peaks = peak,
exp_type = "ChIP",
exp_labels = "CTCF",
read_count = 150,
peak_count = 100
)
motifs <- list(
motifs = list(motif_MA1930.2, motif_MA1102.3),
motif_labels = list("MA1930.2", "MA1102.3")
)
if (requireNamespace("BSgenome.Hsapiens.UCSC.hg38")) {
genome_build <-
BSgenome.Hsapiens.UCSC.hg38::BSgenome.Hsapiens.UCSC.hg38
distances_df_bootstrapped <- get_df_distances_bootstrapped(
input,
user_motifs = motifs,
genome_build = genome_build,
samples_n = NULL,
samples_len = NULL,
verbose = FALSE
)
print(distances_df_bootstrapped)
}
}
#> exp_label exp_type motif_indice bootstrap_iteration distance
#> 1 CTCF ChIP 1 1 23.750000
#> 2 CTCF ChIP 1 2 18.250000
#> 3 CTCF ChIP 1 3 15.400000
#> 4 CTCF ChIP 1 4 21.333333
#> 5 CTCF ChIP 1 5 14.800000
#> 6 CTCF ChIP 1 6 29.333333
#> 7 CTCF ChIP 1 7 15.600000
#> 8 CTCF ChIP 1 8 11.750000
#> 9 CTCF ChIP 1 9 20.600000
#> 10 CTCF ChIP 1 10 17.833333
#> 11 CTCF ChIP 1 11 16.500000
#> 12 CTCF ChIP 1 12 12.500000
#> 13 CTCF ChIP 1 13 30.000000
#> 14 CTCF ChIP 1 14 13.666667
#> 15 CTCF ChIP 1 15 6.750000
#> 16 CTCF ChIP 1 16 17.250000
#> 17 CTCF ChIP 1 17 5.333333
#> 18 CTCF ChIP 1 18 12.250000
#> 19 CTCF ChIP 1 19 15.200000
#> 20 CTCF ChIP 1 20 12.750000
#> 21 CTCF ChIP 1 21 10.800000
#> 22 CTCF ChIP 1 22 29.333333
#> 23 CTCF ChIP 1 23 10.800000
#> 24 CTCF ChIP 1 24 4.333333
#> 25 CTCF ChIP 1 25 20.000000
#> 26 CTCF ChIP 1 26 12.500000
#> 27 CTCF ChIP 1 27 14.000000
#> 28 CTCF ChIP 1 28 5.666667
#> 29 CTCF ChIP 1 29 15.400000
#> 30 CTCF ChIP 1 30 21.200000
#> 31 CTCF ChIP 1 31 17.250000
#> 32 CTCF ChIP 1 32 14.000000
#> 33 CTCF ChIP 1 33 19.800000
#> 34 CTCF ChIP 1 34 11.750000
#> 35 CTCF ChIP 1 35 20.000000
#> 36 CTCF ChIP 1 36 NA
#> 37 CTCF ChIP 1 37 14.800000
#> 38 CTCF ChIP 1 38 7.500000
#> 39 CTCF ChIP 1 39 21.333333
#> 40 CTCF ChIP 1 40 19.800000
#> 41 CTCF ChIP 1 41 4.000000
#> 42 CTCF ChIP 1 42 6.400000
#> 43 CTCF ChIP 1 43 5.333333
#> 44 CTCF ChIP 1 44 17.333333
#> 45 CTCF ChIP 1 45 12.250000
#> 46 CTCF ChIP 1 46 20.666667
#> 47 CTCF ChIP 1 47 13.666667
#> 48 CTCF ChIP 1 48 21.333333
#> 49 CTCF ChIP 1 49 10.333333
#> 50 CTCF ChIP 1 50 8.000000
#> 51 CTCF ChIP 1 51 20.400000
#> 52 CTCF ChIP 1 52 17.250000
#> 53 CTCF ChIP 1 53 18.250000
#> 54 CTCF ChIP 1 54 17.500000
#> 55 CTCF ChIP 1 55 7.000000
#> 56 CTCF ChIP 1 56 5.000000
#> 57 CTCF ChIP 1 57 19.000000
#> 58 CTCF ChIP 1 58 6.666667
#> 59 CTCF ChIP 1 59 24.500000
#> 60 CTCF ChIP 1 60 5.666667
#> 61 CTCF ChIP 1 61 21.666667
#> 62 CTCF ChIP 1 62 21.200000
#> 63 CTCF ChIP 1 63 4.000000
#> 64 CTCF ChIP 1 64 12.250000
#> 65 CTCF ChIP 1 65 10.800000
#> 66 CTCF ChIP 1 66 17.250000
#> 67 CTCF ChIP 1 67 5.666667
#> 68 CTCF ChIP 1 68 5.750000
#> 69 CTCF ChIP 1 69 6.000000
#> 70 CTCF ChIP 1 70 17.000000
#> 71 CTCF ChIP 1 71 17.833333
#> 72 CTCF ChIP 1 72 21.666667
#> 73 CTCF ChIP 1 73 13.666667
#> 74 CTCF ChIP 1 74 23.750000
#> 75 CTCF ChIP 1 75 13.666667
#> 76 CTCF ChIP 1 76 20.400000
#> 77 CTCF ChIP 1 77 22.000000
#> 78 CTCF ChIP 1 78 14.000000
#> 79 CTCF ChIP 1 79 14.800000
#> 80 CTCF ChIP 1 80 5.600000
#> 81 CTCF ChIP 1 81 29.000000
#> 82 CTCF ChIP 1 82 5.250000
#> 83 CTCF ChIP 1 83 18.000000
#> 84 CTCF ChIP 1 84 6.000000
#> 85 CTCF ChIP 1 85 20.666667
#> 86 CTCF ChIP 1 86 7.500000
#> 87 CTCF ChIP 1 87 10.000000
#> 88 CTCF ChIP 1 88 7.000000
#> 89 CTCF ChIP 1 89 5.250000
#> 90 CTCF ChIP 1 90 20.000000
#> 91 CTCF ChIP 1 91 17.500000
#> 92 CTCF ChIP 1 92 18.000000
#> 93 CTCF ChIP 1 93 6.000000
#> 94 CTCF ChIP 1 94 17.250000
#> 95 CTCF ChIP 1 95 20.600000
#> 96 CTCF ChIP 1 96 10.333333
#> 97 CTCF ChIP 1 97 41.500000
#> 98 CTCF ChIP 1 98 19.600000
#> 99 CTCF ChIP 1 99 17.833333
#> 100 CTCF ChIP 1 100 15.400000
#> 101 CTCF ChIP 2 1 14.500000
#> 102 CTCF ChIP 2 2 11.166667
#> 103 CTCF ChIP 2 3 126.500000
#> 104 CTCF ChIP 2 4 48.500000
#> 105 CTCF ChIP 2 5 40.000000
#> 106 CTCF ChIP 2 6 14.500000
#> 107 CTCF ChIP 2 7 40.000000
#> 108 CTCF ChIP 2 8 126.500000
#> 109 CTCF ChIP 2 9 NA
#> 110 CTCF ChIP 2 10 48.500000
#> 111 CTCF ChIP 2 11 70.500000
#> 112 CTCF ChIP 2 12 126.500000
#> 113 CTCF ChIP 2 13 11.166667
#> 114 CTCF ChIP 2 14 9.500000
#> 115 CTCF ChIP 2 15 11.166667
#> 116 CTCF ChIP 2 16 70.500000
#> 117 CTCF ChIP 2 17 70.500000
#> 118 CTCF ChIP 2 18 NA
#> 119 CTCF ChIP 2 19 70.500000
#> 120 CTCF ChIP 2 20 48.500000
#> 121 CTCF ChIP 2 21 11.166667
#> 122 CTCF ChIP 2 22 70.500000
#> 123 CTCF ChIP 2 23 70.500000
#> 124 CTCF ChIP 2 24 126.500000
#> 125 CTCF ChIP 2 25 9.500000
#> 126 CTCF ChIP 2 26 NA
#> 127 CTCF ChIP 2 27 9.500000
#> 128 CTCF ChIP 2 28 9.500000
#> 129 CTCF ChIP 2 29 14.500000
#> 130 CTCF ChIP 2 30 40.000000
#> 131 CTCF ChIP 2 31 11.166667
#> 132 CTCF ChIP 2 32 126.500000
#> 133 CTCF ChIP 2 33 48.500000
#> 134 CTCF ChIP 2 34 70.500000
#> 135 CTCF ChIP 2 35 40.000000
#> 136 CTCF ChIP 2 36 9.500000
#> 137 CTCF ChIP 2 37 126.500000
#> 138 CTCF ChIP 2 38 126.500000
#> 139 CTCF ChIP 2 39 126.500000
#> 140 CTCF ChIP 2 40 NA
#> 141 CTCF ChIP 2 41 9.500000
#> 142 CTCF ChIP 2 42 14.500000
#> 143 CTCF ChIP 2 43 40.000000
#> 144 CTCF ChIP 2 44 48.500000
#> 145 CTCF ChIP 2 45 48.500000
#> 146 CTCF ChIP 2 46 14.500000
#> 147 CTCF ChIP 2 47 9.500000
#> 148 CTCF ChIP 2 48 NA
#> 149 CTCF ChIP 2 49 126.500000
#> 150 CTCF ChIP 2 50 NA
#> 151 CTCF ChIP 2 51 70.500000
#> 152 CTCF ChIP 2 52 9.500000
#> 153 CTCF ChIP 2 53 14.500000
#> 154 CTCF ChIP 2 54 48.500000
#> 155 CTCF ChIP 2 55 9.500000
#> 156 CTCF ChIP 2 56 48.500000
#> 157 CTCF ChIP 2 57 11.166667
#> 158 CTCF ChIP 2 58 11.166667
#> 159 CTCF ChIP 2 59 126.500000
#> 160 CTCF ChIP 2 60 11.166667
#> 161 CTCF ChIP 2 61 48.500000
#> 162 CTCF ChIP 2 62 NA
#> 163 CTCF ChIP 2 63 14.500000
#> 164 CTCF ChIP 2 64 11.166667
#> 165 CTCF ChIP 2 65 NA
#> 166 CTCF ChIP 2 66 14.500000
#> 167 CTCF ChIP 2 67 126.500000
#> 168 CTCF ChIP 2 68 40.000000
#> 169 CTCF ChIP 2 69 70.500000
#> 170 CTCF ChIP 2 70 NA
#> 171 CTCF ChIP 2 71 14.500000
#> 172 CTCF ChIP 2 72 9.500000
#> 173 CTCF ChIP 2 73 48.500000
#> 174 CTCF ChIP 2 74 126.500000
#> 175 CTCF ChIP 2 75 126.500000
#> 176 CTCF ChIP 2 76 9.500000
#> 177 CTCF ChIP 2 77 14.500000
#> 178 CTCF ChIP 2 78 14.500000
#> 179 CTCF ChIP 2 79 70.500000
#> 180 CTCF ChIP 2 80 126.500000
#> 181 CTCF ChIP 2 81 40.000000
#> 182 CTCF ChIP 2 82 11.166667
#> 183 CTCF ChIP 2 83 48.500000
#> 184 CTCF ChIP 2 84 48.500000
#> 185 CTCF ChIP 2 85 9.500000
#> 186 CTCF ChIP 2 86 9.500000
#> 187 CTCF ChIP 2 87 9.500000
#> 188 CTCF ChIP 2 88 48.500000
#> 189 CTCF ChIP 2 89 9.500000
#> 190 CTCF ChIP 2 90 14.500000
#> 191 CTCF ChIP 2 91 11.166667
#> 192 CTCF ChIP 2 92 NA
#> 193 CTCF ChIP 2 93 40.000000
#> 194 CTCF ChIP 2 94 11.166667
#> 195 CTCF ChIP 2 95 11.166667
#> 196 CTCF ChIP 2 96 14.500000
#> 197 CTCF ChIP 2 97 126.500000
#> 198 CTCF ChIP 2 98 40.000000
#> 199 CTCF ChIP 2 99 126.500000
#> 200 CTCF ChIP 2 100 9.500000