parallel_report: Run reports on peak callings in parallel with bash sever.

Description Usage Arguments Value Examples

View source: R/parallel_report.R

Description

Run reports on peak callings in parallel with bash sever.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
parallel_report(
  pkc_dir = "~/exomepeak2_test",
  pkc_prefix = "pkc_",
  pkc_suffix = ".rds",
  autocreate = TRUE,
  save_dir = "~/exomepeak2_GC_peaks",
  parallel_num = 9,
  report_function = reads_GC_plot,
  front_name = "GCreads_"
)

Arguments

pkc_dir

the directory containing the Peak calling results in RDS format.

pkc_prefix

a character of the prefix of the peakcalling result files; default "pkc_".

pkc_suffix

a character of the suffix of the peakcalling result files; default ".rds".

autocreate

a logical, TRUE if create the save_dir when it does not exist; default TRUE.

save_dir

the directory to save the reported files.

parallel_num

an integer indicates the number of parallel process created; default = 6.

report_function

a report function that takes the peak calling result as the input, and take a code string as output.

front_name

a character string define the prefixes of the saved files.

...

arguments that can be passed to the report function.

Value

multiple report files on peak calling results, which will use the same middle name.

Examples

1
2
3
4
5
6
7
8
parallel_report(
 pkc_dir = "~/exomepeak2_test"
 pkc_prefix = "pkc_",
 pkc_suffix = ".rds",
 save_dir = "~/exomepeak2_GC_peaks",
 parallel_num = 9,
 report_function = reads_GC_plot
)

ZW-xjtlu/exomePeak2Test documentation built on Jan. 6, 2020, 3:36 p.m.