Skip to content

Commit

Permalink
simplify argument names
Browse files Browse the repository at this point in the history
  • Loading branch information
emmarousseau committed Jul 18, 2024
1 parent 48e5fb4 commit 09a6145
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 16 deletions.
8 changes: 3 additions & 5 deletions src/umi_tools/umi_tools_extract/config.vsh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,7 @@ argument_groups:
- name: Extract Options
arguments:
- name: --umitools_extract_method
alternatives: --extract_method
- name: --extract_method
type: string
choices: [string, regex]
description: |
Expand Down Expand Up @@ -116,14 +115,13 @@ argument_groups:
Ignore "/1" and "/2" read name suffixes. Note that this options is required if the suffixes are not whitespace
separated from the rest of the read name.
arguments:
- name: --umitools_umi_separator
alternatives: --umi_separator
- name: --umi_separator
type: string
description: |
The character that separates the UMI in the read name. Most likely a colon if you skipped the extraction with
UMI-tools and used other software. Default: `_`
example: "_"
- name: --umitools_grouping_method
- name: --grouping_method
type: string
choices: [unique, percentile, cluster, adjacency, directional]
description: |
Expand Down
4 changes: 2 additions & 2 deletions src/umi_tools/umi_tools_extract/script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ umi_tools extract \
${par_read2_in:+ --read2-in "$par_read2_in"} \
-S "$par_read1_out" \
${par_read2_out:+--read2-out "$par_read2_out"} \
${par_umitools_extract_method:+--extract-method "$par_umitools_extract_method"} \
${par_extract_method:+--extract-method "$par_extract_method"} \
--bc-pattern "$par_bc_pattern" \
${par_bc_pattern2:+ --bc-pattern2 "$par_bc_pattern2"} \
${par_umitools_umi_separator:+--umi-separator "$par_umitools_umi_separator"} \
${par_umi_separator:+--umi-separator "$par_umi_separator"} \
${par_output_stats:+--output-stats "$par_output_stats"} \
${par_error_correct_cell:+--error-correct-cell} \
${par_whitelist:+--whitelist "$par_whitelist"} \
Expand Down
18 changes: 9 additions & 9 deletions src/umi_tools/umi_tools_extract/test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ echo ">>> Test 1: Testing for paired-end reads"
--read2_in "$test_dir/scrb_seq_fastq.2_30" \
--bc_pattern "CCCCCCNNNNNNNNNN"\
--bc_pattern2 "CCCCCCNNNNNNNNNN" \
--umitools_extract_method string \
--umitools_umi_separator '_' \
--umitools_grouping_method directional \
--extract_method string \
--umi_separator '_' \
--grouping_method directional \
--umi_discard_read 0 \
--read1_out scrb_seq_fastq.1_30.extract \
--read2_out scrb_seq_fastq.2_30.extract \
Expand Down Expand Up @@ -44,9 +44,9 @@ echo ">>> Test 2: Testing for paired-end reads with umi_discard_reads option"
--read2_in "$test_dir/scrb_seq_fastq.2_30" \
--bc_pattern CCCCCCNNNNNNNNNN \
--bc_pattern2 CCCCCCNNNNNNNNNN \
--umitools_extract_method string \
--umitools_umi_separator '_' \
--umitools_grouping_method directional \
--extract_method string \
--umi_separator '_' \
--grouping_method directional \
--umi_discard_read 2 \
--read1_out scrb_seq_fastq.1_30.extract \
--random_seed 1
Expand All @@ -68,9 +68,9 @@ echo ">>> Test 3: Testing for single-end reads"
"$meta_executable" \
--input "$test_dir/slim_30.fastq" \
--bc_pattern "^(?P<umi_1>.{3}).{4}(?P<umi_2>.{2})" \
--umitools_extract_method regex \
--umitools_umi_separator '_' \
--umitools_grouping_method directional \
--extract_method regex \
--umi_separator '_' \
--grouping_method directional \
--read1_out slim_30.extract \
--random_seed 1

Expand Down

0 comments on commit 09a6145

Please sign in to comment.