Good practices for BOBaFIT package
BOBaFIT 1.11.0
The R package BoBafit is composed of four functions which allow the refit and the recalibration of copy number profile of tumor sample. In particular, the package was built to check, and possibly correct, the diploid regions. The wrong diploid region is a phenomenon that very often affects the profiles of samples with a very complex karyotype.
The principal and refitting function was named DRrefit
, which - throughout a chromosome clustering method and a list of unaltered chromosomes (chromosome list) - recalibrates the copy number values. BoBafit also contains three secondary functions: ComputeNormalChromosome
, which generates the chromosome list; PlotChrCluster
, where is possible to visualize the cluster; and Popeye
, which affixes its chromosomal arm to each segment (see in “Data Preparation” vignette).
The package checks the diploid region assessment working on pre-estimated segment information, as the copy number and their position. We included a data set TCGA_BRCA_CN_segments
where are showed all the information necessary. The data correspond to segments about 100 breast tumors samples obtained by the project TCGA-BRCA (Tomczak, Czerwińska, and Wiznerowicz 2015). In the “Data Preparation” vingnette is shown how we download and prepare the dataset for the following analysis.
## Warning: replacing previous import 'ggplot2::geom_segment' by
## 'ggbio::geom_segment' when loading 'BOBaFIT'
Once the dataset has been prepared, the next step is to generate the chromosome list. The chromosome list is a vector containing all chromosomal arm which are the least affected by SCNAs in the tumor analyzed. Together with the clustering, the chromosome list is one the operating principles to rewrite the diploid region. The list can be manually created or by using the function ComputeNormalChromosome
. We suggest these two sequential steps to allow the right refit and recalibration of sample’s diploid region:
ComputeNormalChromosome()
DRrefit()
Here we performed this analysis workflow on the dataset TCGA_BRCA_CN_segments
described above.
The chromosome list is a vector specific for each tumor (type and subtype) . The chromosome arms included in this list must be selected based on how many CNA events they are subject to and how many times their CN falls into a “diploid range”. According to this principle, ComputeNormalChromosome write the chromosome list. The function allows to set the chromosomal alteration rate (tolerance_val
), which corresponds to a minimum percentage of alterations that one wants to tolerate per arm.
With a little dataframe (less than 200 samples), we suggest an alteration rate of 5% (0.5) ; on the contrary, With a big dataframe (about 1000 samples), we suggest as maximum rate 20-25% (0.20-0.25) . The function input is a sample cohort with their segments.
Here we performed the function in the data set TCGA_BRCA_CN_segments
, using an alteration rate of 25%.
chr_list
[1] “10q” “12q” “15q” “2p” “2q” “3p” “4q” “9q”
Storing the result in the variable chr_list
, it will be a vector containing the chromosomal arms which present an alteration rate under the indicated tolerance_val
value.
The function also plots in the Viewer a histogram where is possible observe the chromosomal alteration rate of each chromosomal arms and which one have been selected in the chromosome list (blue bars). The tolerance value has been set at 0.25 (dotted line).
\end{kframe}\begin{adjustwidth}{}{0mm} \includegraphics[width=100%]{/tmp/RtmplXpsds/Rbuild7c3ef3a37abab/BOBaFIT/vignettes/BOBaFIT_files/figure-html/chrlist plot-1} \end{adjustwidth} \begin{adjustwidth}{}{0mm} \includegraphics[width=100%]{/tmp/RtmplXpsds/Rbuild7c3ef3a37abab/BOBaFIT/vignettes/BOBaFIT_files/figure-html/DRrefit_plot 1-1} \end{adjustwidth}\begin{adjustwidth}{}{0mm} \includegraphics[width=100%]{/tmp/RtmplXpsds/Rbuild7c3ef3a37abab/BOBaFIT/vignettes/BOBaFIT_files/figure-html/DRrefit_plot 2-1} \end{adjustwidth}\begin{kframe}
Another accessory function is PlotChrCluster
. It can be used to visualize the chromosomal cluster in a single sample or in a sample cohort. The input data is always a .tsv file, as the data frame TCGA_BRCA_CN_segments
. The option of clust_method
argument are the same of DRrefit
(“ward.D”, “ward.D2”, “single”, “complete”, “average”, “mcquitty”, “median”, “centroid” and “kmeans”).
Cluster <- PlotChrCluster(segs = TCGA_BRCA_CN_segments,
clust_method = "ward.D2",
plot_output= TRUE)
We suggest to store the output on a variable (in this example we use Cluster
) to view and possibly save the data frame generated. The PlotCuster
will automatically save the plot in the folder indicated by the variable path
of the argument plot_path
.
In the PlotChrCluster
plot, the chromosomal arms are labeled and colored according to the cluster they belong to. The y-axis reports the arm CN.
The outputs report
summarizes the outcome of clustering for each sample (fail or succeeded, the number of clusters), similar to DRrefit report output. The second output, plot tables
, is a list of data frames (one per sample) and reports in which clustering the chromosomes of the sample have been placed.
head(Cluster$report)
#select plot table per sample
head(Cluster$plot_tables$`01428281-1653-4839-b5cf-167bc62eb147`)
knitr::kable(head(Cluster$report))
sample | clustering | num_clust |
---|---|---|
01428281-1653-4839-b5cf-167bc62eb147 | SUCCEDED | 3 |
01bc5261-bf91-4f7b-a6b4-0e727c5e31d2 | SUCCEDED | 2 |
05afee4e-9acd-44f1-8a0c-ffa34d772b9c | SUCCEDED | 3 |
091f70c0-586a-49e8-a0e5-0b60caa72c1b | SUCCEDED | 3 |
0941a978-c8aa-467b-8464-9f979d1f0418 | SUCCEDED | 2 |
#select plot table per sample
knitr::kable(head(Cluster$plot_tables$`01428281-1653-4839-b5cf-167bc62eb147`))
chr | cluster | CN |
---|---|---|
1p | cluster1 | 1.670236 |
1q | cluster2 | 3.140345 |
2p | cluster1 | 1.906657 |
2q | cluster1 | 1.911449 |
3p | cluster1 | 1.996745 |
3q | cluster2 | 2.624881 |
## R Under development (unstable) (2024-10-21 r87258)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 24.04.1 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.21-bioc/R/lib/libRblas.so
## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.12.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
## [3] LC_TIME=en_GB LC_COLLATE=C
## [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
## [9] LC_ADDRESS=C LC_TELEPHONE=C
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## time zone: America/New_York
## tzcode source: system (glibc)
##
## attached base packages:
## [1] stats graphics grDevices utils datasets methods base
##
## other attached packages:
## [1] dplyr_1.1.4 BOBaFIT_1.11.0 BiocStyle_2.35.0
##
## loaded via a namespace (and not attached):
## [1] RColorBrewer_1.1-3 rstudioapi_0.17.1
## [3] jsonlite_1.8.9 magrittr_2.0.3
## [5] magick_2.8.5 GenomicFeatures_1.59.0
## [7] farver_2.1.2 rmarkdown_2.28
## [9] BiocIO_1.17.0 zlibbioc_1.53.0
## [11] vctrs_0.6.5 memoise_2.0.1
## [13] Rsamtools_2.23.0 RCurl_1.98-1.16
## [15] base64enc_0.1-3 tinytex_0.53
## [17] htmltools_0.5.8.1 S4Arrays_1.7.0
## [19] progress_1.2.3 curl_5.2.3
## [21] SparseArray_1.7.0 Formula_1.2-5
## [23] sass_0.4.9 bslib_0.8.0
## [25] htmlwidgets_1.6.4 httr2_1.0.5
## [27] plyr_1.8.9 cachem_1.1.0
## [29] GenomicAlignments_1.43.0 lifecycle_1.0.4
## [31] pkgconfig_2.0.3 Matrix_1.7-1
## [33] R6_2.5.1 fastmap_1.2.0
## [35] GenomeInfoDbData_1.2.13 MatrixGenerics_1.19.0
## [37] digest_0.6.37 colorspace_2.1-1
## [39] GGally_2.2.1 AnnotationDbi_1.69.0
## [41] S4Vectors_0.45.0 OrganismDbi_1.49.0
## [43] Hmisc_5.2-0 GenomicRanges_1.59.0
## [45] RSQLite_2.3.7 labeling_0.4.3
## [47] filelock_1.0.3 fansi_1.0.6
## [49] polyclip_1.10-7 httr_1.4.7
## [51] abind_1.4-8 compiler_4.5.0
## [53] withr_3.0.2 bit64_4.5.2
## [55] htmlTable_2.4.3 backports_1.5.0
## [57] BiocParallel_1.41.0 DBI_1.2.3
## [59] ggstats_0.7.0 ggforce_0.4.2
## [61] biomaRt_2.63.0 MASS_7.3-61
## [63] rappdirs_0.3.3 DelayedArray_0.33.0
## [65] rjson_0.2.23 tools_4.5.0
## [67] foreign_0.8-87 nnet_7.3-19
## [69] glue_1.8.0 restfulr_0.0.15
## [71] grid_4.5.0 checkmate_2.3.2
## [73] cluster_2.1.6 reshape2_1.4.4
## [75] generics_0.1.3 gtable_0.3.6
## [77] BSgenome_1.75.0 tidyr_1.3.1
## [79] ensembldb_2.31.0 data.table_1.16.2
## [81] hms_1.1.3 xml2_1.3.6
## [83] utf8_1.2.4 XVector_0.47.0
## [85] BiocGenerics_0.53.0 pillar_1.9.0
## [87] stringr_1.5.1 tweenr_2.0.3
## [89] BiocFileCache_2.15.0 lattice_0.22-6
## [91] rtracklayer_1.67.0 bit_4.5.0
## [93] biovizBase_1.55.0 RBGL_1.83.0
## [95] tidyselect_1.2.1 Biostrings_2.75.0
## [97] knitr_1.48 gridExtra_2.3
## [99] bookdown_0.41 ggbio_1.55.0
## [101] IRanges_2.41.0 ProtGenerics_1.39.0
## [103] SummarizedExperiment_1.37.0 stats4_4.5.0
## [105] xfun_0.48 Biobase_2.67.0
## [107] matrixStats_1.4.1 stringi_1.8.4
## [109] UCSC.utils_1.3.0 lazyeval_0.2.2
## [111] yaml_2.3.10 evaluate_1.0.1
## [113] codetools_0.2-20 NbClust_3.0.1
## [115] tibble_3.2.1 graph_1.85.0
## [117] BiocManager_1.30.25 cli_3.6.3
## [119] rpart_4.1.23 munsell_0.5.1
## [121] jquerylib_0.1.4 dichromat_2.0-0.1
## [123] Rcpp_1.0.13 GenomeInfoDb_1.43.0
## [125] dbplyr_2.5.0 png_0.1-8
## [127] XML_3.99-0.17 parallel_4.5.0
## [129] ggplot2_3.5.1 blob_1.2.4
## [131] prettyunits_1.2.0 AnnotationFilter_1.31.0
## [133] plyranges_1.27.0 bitops_1.0-9
## [135] txdbmaker_1.3.0 VariantAnnotation_1.53.0
## [137] scales_1.3.0 purrr_1.0.2
## [139] crayon_1.5.3 rlang_1.1.4
## [141] KEGGREST_1.47.0