Skip to content

Commit 7884814

Browse files
authored
Remove LINX support (#74)
* linx functionality moved to umccr/linxreport * linx functionality moved to umccr/linxreport * remove linx dvc data * remove tidymultiqc remnants * remove run_chord_hrdetect.R * remove inst/rmd/linx * remove vignettes/linx.Rmd
1 parent 0131b52 commit 7884814

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+2
-2304
lines changed

DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,5 @@ ByteCompile: true
5252
Config/testthat/edition: 3
5353
Encoding: UTF-8
5454
LazyData: true
55-
RoxygenNote: 7.2.3
55+
RoxygenNote: 7.3.1
5656
VignetteBuilder: knitr

NAMESPACE

-21
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,6 @@ export(date_log)
66
export(hrd_results_tabs)
77
export(is_vcf)
88
export(is_vcf_bpi)
9-
export(linx_breakend_process)
10-
export(linx_breakend_read)
11-
export(linx_clusters_process)
12-
export(linx_clusters_read)
13-
export(linx_drivercatalog_process)
14-
export(linx_drivercatalog_read)
15-
export(linx_drivers_process)
16-
export(linx_drivers_read)
17-
export(linx_fusion_process)
18-
export(linx_fusion_read)
19-
export(linx_links_process)
20-
export(linx_links_read)
21-
export(linx_rmd)
22-
export(linx_svs_process)
23-
export(linx_svs_read)
24-
export(linx_viscopynumber_read)
25-
export(linx_visfusion_read)
26-
export(linx_visgeneexon_read)
27-
export(linx_visproteindomain_read)
28-
export(linx_vissegments_read)
29-
export(linx_vissvdata_read)
309
export(mkdir)
3110
export(pkg_exists)
3211
export(plot_bnd_sr_pr_tot_hist)

R/linx.R

-449
This file was deleted.

R/linx_vis.R

-188
This file was deleted.

R/rmd.R

-55
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,3 @@
1-
#' Generate UMCCR LINX Report
2-
#'
3-
#' Generates a UMCCR LINX HTML report. It does so with the following steps:
4-
#' 1. recursively copy the table and plot directories into tmp/plot and tmp/table
5-
#' 2. copy the rmd into tmp/linx.Rmd
6-
#' 3. render the rmd inside tmp/
7-
#' 4. return the path to the output HTML
8-
#'
9-
#' @param sample Name of sample.
10-
#' @param table_dir Path to LINX table directory.
11-
#' @param plot_dir Path to LINX plot directory.
12-
#' @param out_file Path to output HTML file (needs '.html' suffix).
13-
#' @param quiet Suppress printing during rendering.
14-
#'
15-
#' @return Path to rendered HTML report.
16-
#' @export
17-
linx_rmd <- function(sample, table_dir, plot_dir, out_file = NULL, quiet = FALSE) {
18-
assertthat::assert_that(
19-
is.character(sample), nchar(sample) > 0,
20-
dir.exists(table_dir), dir.exists(plot_dir),
21-
quiet %in% c(FALSE, TRUE)
22-
)
23-
if (!is.null(out_file)) {
24-
assertthat::assert_that(
25-
is.character(out_file),
26-
tools::file_ext(out_file) == "html"
27-
)
28-
} else {
29-
out_file <- glue::glue("linx_{sample}.html")
30-
}
31-
tmp_dir <- tempdir()
32-
rmd_dir <- system.file("rmd/linx", package = "gpgr")
33-
cpdir(table_dir, tmp_dir)
34-
cpdir(plot_dir, tmp_dir)
35-
cpdir(rmd_dir, tmp_dir)
36-
rmd_file <- file.path(tmp_dir, "linx", "linx.Rmd")
37-
out_dir <- dirname(out_file)
38-
mkdir(out_dir)
39-
pars <- list(
40-
table_dir = table_dir,
41-
plot_dir = plot_dir,
42-
sample = sample
43-
)
44-
# suppress DT large size warning
45-
options(DT.warn.size = FALSE)
46-
rmarkdown::render(
47-
input = rmd_file,
48-
params = pars,
49-
output_dir = out_dir,
50-
output_file = I(out_file),
51-
run_pandoc = TRUE,
52-
quiet = quiet
53-
)
54-
}
55-
561
#' Generate UMCCR Cancer Report
572
#'
583
#' Generates a UMCCR Cancer Report. It does so with the following steps:

README.Rmd

-13
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,6 @@ conda install r-gpgr -c umccr -c conda-forge -c bioconda
4040

4141
## Main modules
4242

43-
### 🕸 LINX {#id_-linx}
44-
45-
- Generate a HTML report with results from the `LINX` structural variant
46-
visualisation tool from the Hartwig Medical Foundation
47-
(<https://github.com/hartwigmedical/hmftools/tree/master/linx>).
48-
See the [CLI](#cli) section below for options.
49-
- For useful functions for reading/processing `LINX` results, see the vignette at
50-
<https://umccr.github.io/gpgr/articles/linx.html>.
51-
5243
### 🔮 PURPLE {#id_-purple}
5344

5445
- Read and process output files from the `PURPLE` purity/copy number estimator
@@ -89,10 +80,6 @@ echo "#-----------------------------------#"
8980
echo "gpgr.R --help" & gpgr.R --help
9081
echo ""
9182
echo "#-----------------------------------#"
92-
echo "#------- LINX Report -------#"
93-
echo "gpgr.R linx --help" & gpgr.R linx --help
94-
echo ""
95-
echo "#-----------------------------------#"
9683
echo "#------- Cancer Report -------#"
9784
echo "gpgr.R canrep --help" & gpgr.R canrep --help
9885
echo ""

inst/cli/gpgr.R

+1-5
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,15 @@ p$add_argument("-v", "--version", action = "version", version = glue::glue("{pro
1212
subparser_name <- "subparser_name"
1313
subp <- p$add_subparsers(help = "sub-command help", dest = subparser_name)
1414

15-
source(system.file("cli/linx.R", package = "gpgr"))
1615
source(system.file("cli/canrep.R", package = "gpgr"))
1716

18-
linx_add_args(subp)
1917
canrep_add_args(subp)
2018

2119
args <- p$parse_args()
2220
if (length(args$subparser_name) == 0) {
2321
p$print_help()
24-
} else if (args$subparser_name == "linx") {
25-
linx_parse_args(args)
2622
} else if (args$subparser_name == "canrep") {
2723
canrep_parse_args(args)
2824
} else {
29-
stop("Need to specify 'linx' or 'canrep' in the cli...")
25+
stop("Need to specify 'canrep' in the cli...")
3026
}

inst/cli/linx.R

-24
This file was deleted.

inst/extdata/linx/README.md

-5
This file was deleted.

inst/extdata/linx/tables/.gitignore

-15
This file was deleted.

inst/extdata/linx/tables/linx.breakend.tsv.gz.dvc

-4
This file was deleted.

inst/extdata/linx/tables/linx.clusters.tsv.gz.dvc

-4
This file was deleted.

inst/extdata/linx/tables/linx.driver.catalog.tsv.gz.dvc

-4
This file was deleted.

inst/extdata/linx/tables/linx.drivers.tsv.gz.dvc

-4
This file was deleted.

0 commit comments

Comments
 (0)