add groovy function to validate blastn database format and busco line… #204
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,8 +3,6 @@ | |
| // | ||
|
|
||
| include { samplesheetToList } from 'plugin/nf-schema' | ||
| include { UNTAR } from '../../modules/nf-core/untar/main' | ||
| include { CAT_CAT } from '../../modules/nf-core/cat/cat/main' | ||
| include { SAMTOOLS_FLAGSTAT } from '../../modules/nf-core/samtools/flagstat/main' | ||
|
|
@@ -45,6 +43,14 @@ workflow INPUT_CHECK { | |
| .map { db_meta, db_path -> | ||
| if (db_meta.type in ["blastp", "blastx"] && db_path.isDirectory()) { | ||
| [db_meta, file(db_path.toString() + "/${db_path.name}", checkIfExists: true)] | ||
| } else if (db_meta.type == "blastn") { | ||
| // Special handling for BLAST nucleotide databases | ||
| def (resolved_path, db_name) = validateBlastnDatabase(db_path) | ||
| [db_meta, resolved_path] | ||
| } else if (db_meta.type == "busco") { | ||
| // Special handling for BUSCO databases | ||
| def resolved_path = validateBuscoDatabase(db_path) | ||
| [db_meta, resolved_path] | ||
| } else { | ||
| [db_meta, db_path] | ||
| } | ||
|
|
@@ -272,3 +278,171 @@ def get_read_counts ( stats ) { | |
|
|
||
| return read_count_meta | ||
| } | ||
|
|
||
| /* | ||
| * Function to validate and resolve BUSCO database paths | ||
| * Handles the common user error of including '/lineages' at the end of the path | ||
| */ | ||
| def validateBuscoDatabase(db_path) { | ||
| def path_file = file(db_path) | ||
| if (path_file.isDirectory()) { | ||
| // Check if path ends with /lineages and has a parent directory | ||
| if (path_file.name == 'lineages' && path_file.parent != null) { | ||
| def parent_dir = file(path_file.parent) | ||
| log.info "BUSCO path correction: Detected '/lineages' suffix in path" | ||
| log.info " Original path: ${path_file}" | ||
| log.info " Corrected path: ${parent_dir}" | ||
| log.info "This prevents the common error where BUSCO tries to use '${path_file}/lineages/lineage_name' instead of '${parent_dir}/lineages/lineage_name'" | ||
| return parent_dir | ||
| } | ||
| // Check if path points to a specific lineage directory (e.g., eukaryota_odb10) | ||
| else if (path_file.name.endsWith('_odb10') && path_file.parent != null) { | ||
| def parent_dir = file(path_file.parent) | ||
| // Check if parent is 'lineages' - if so, we need to go up two levels | ||
| if (parent_dir.name == 'lineages' && parent_dir.parent != null) { | ||
| def busco_root = file(parent_dir.parent) | ||
| log.info "BUSCO path correction: Detected specific lineage directory in path" | ||
| log.info " Original path: ${path_file} (specific lineage: ${path_file.name})" | ||
| log.info " Corrected path: ${busco_root}" | ||
| log.info "This prevents the error where BUSCO tries to use a specific lineage directory instead of the root BUSCO database directory" | ||
| log.warn "Use `--busco_lineages ${path_file.name}` to control the lineage" | ||
| return busco_root | ||
| } else { | ||
| error """ | ||
| ERROR: Invalid BUSCO lineage directory structure: ${path_file} | ||
| It appears you're pointing to a specific BUSCO lineage directory (${path_file.name}), | ||
| but the expected directory structure is: | ||
| /path/to/busco_downloads/lineages/${path_file.name}/ | ||
| Please provide the path to the root BUSCO database directory. | ||
| Example: --busco /path/to/busco_downloads/ | ||
| """ | ||
| } | ||
| } else { | ||
| // Path looks correct, return as-is | ||
| log.info "Using BUSCO database path: ${path_file}" | ||
| return path_file | ||
| } | ||
yumisims marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } else { | ||
| error """ | ||
| ERROR: Invalid BUSCO database path: ${path_file} | ||
| BUSCO databases must be directories containing the 'lineages/' subdirectory. | ||
| Please ensure the path points to a valid BUSCO database directory. | ||
| Common issues: | ||
| - Path should point to the directory containing 'lineages/' subdirectory | ||
| - Do NOT include '/lineages' at the end of the path | ||
| - Do NOT point to a specific lineage directory (e.g., eukaryota_odb10) | ||
| - BUSCO databases cannot be individual files | ||
| Example: --busco /path/to/busco_downloads/ | ||
| NOT: --busco /path/to/busco_downloads/lineages/ | ||
| NOT: --busco /path/to/busco_downloads/lineages/eukaryota_odb10/ | ||
| """ | ||
| } | ||
| } | ||
|
|
||
| /* | ||
| * Function to validate and resolve BLAST nucleotide database paths | ||
| * Handles both directory paths (for backwards compatibility) and direct .nal file paths | ||
| */ | ||
| def validateBlastnDatabase(db_path) { | ||
|
Member
There was a problem hiding this comment. There's still a problem with the way the function is used. When people mix multiple Blast databases under the same directory (like in #184), yes, they can now refer to one
Contributor
Author
There was a problem hiding this comment. the db_name parameter is now implemented and flows from the validation function to the BLAST module. |
||
| def path_file = file(db_path) | ||
| if (path_file.isFile()) { | ||
| // Direct file provided - validate it's a .nal file and create isolated directory | ||
| if (path_file.name.endsWith('.nal')) { | ||
| if (!path_file.exists()) { | ||
| error """ | ||
| ERROR: BLAST database file not found: ${path_file} | ||
| Please check that the path is correct and the file exists. | ||
| """ | ||
| } | ||
| def parent_dir = file(path_file.parent) | ||
| def db_name = path_file.name.replaceAll('\\.nal$', '') | ||
|
|
||
| // Create a temporary directory with symlinks to only the specified database files | ||
| def temp_dir = file("${parent_dir}/.btk_isolated_${db_name}") | ||
|
Member
There was a problem hiding this comment. Unfortunately we may not always have write access to that directory (for instance, in production we don't – |
||
| if (!temp_dir.exists()) { | ||
| temp_dir.mkdirs() | ||
|
Member
There was a problem hiding this comment. Funnily, this doesn't seem to complain if the directory can't be created. It just carries on (and the pipeline fails later). $ nextflow run -profile sanger,singularity,test --blastn /data/tol/resources/nt/latest/nt.nal
(...)
Direct BLAST database file specified: /data/tol/resources/nt/latest/nt.nal
Database name: nt
Created isolated directory: /data/tol/resources/nt/latest/.btk_isolated_nt
This ensures only the specified database is available to BLAST
(...)
Execution cancelled -- Finishing pending tasks before exit
-[sanger-tol/blobtoolkit] Pipeline completed with errors-
(...)
Command error:
(...)
File "/nfs/users/nfs_m/mm49/workspace/tol-it/nextflow/sanger-tol/blobtoolkit_param/bin/generate_config.py", line 230, in adjust_taxon_id
con = sqlite3.connect(os.path.join(nt, "taxonomy4blast.sqlite3"))
sqlite3.OperationalError: unable to open database file
(...)
$ ls -ld /data/tol/resources/nt/latest/.btk_isolated_nt
ls: cannot access '/data/tol/resources/nt/latest/.btk_isolated_nt': No such file or directory |
||
| } | ||
|
|
||
| // Find all files belonging to this specific database | ||
| def db_files = parent_dir.listFiles().findAll { | ||
| it.name.startsWith("${db_name}.") || | ||
| it.name in ['taxdb.btd', 'taxdb.bti', 'taxonomy4blast.sqlite3'] | ||
| } | ||
|
|
||
| // Create symlinks in the temporary directory | ||
| db_files.each { source_file -> | ||
| def link_file = file("${temp_dir}/${source_file.name}") | ||
| if (!link_file.exists()) { | ||
| // Create symbolic link | ||
| link_file.createLink(source_file) | ||
| } | ||
| } | ||
|
|
||
| log.info "Direct BLAST database file specified: ${path_file}" | ||
| log.info "Database name: ${db_name}" | ||
| log.info "Created isolated directory: ${temp_dir}" | ||
| log.info "This ensures only the specified database is available to BLAST" | ||
| return [temp_dir, db_name] | ||
| } else { | ||
| error """ | ||
| ERROR: Invalid BLAST database file: ${path_file} | ||
| The file must have a .nal extension. | ||
| Please provide either: | ||
| - A directory containing a single BLAST database | ||
| - The direct path to a .nal file | ||
| Example: --blastn /path/to/databases/nt.nal | ||
| """ | ||
| } | ||
| } else if (path_file.isDirectory()) { | ||
| // Directory provided - search for database files | ||
| log.info "Searching for BLAST database files in directory: ${path_file}" | ||
| // Look for .nal files | ||
| def nal_files = path_file.listFiles().findAll { it.name.endsWith('.nal') } | ||
| if (nal_files.size() == 1) { | ||
| log.info "Found single BLAST database: ${nal_files[0].name}" | ||
| return [path_file, null] // Return directory with no specific db name | ||
| } else if (nal_files.size() > 1) { | ||
| def db_names = nal_files.collect { it.name }.join('\n - ') | ||
| error """ | ||
| ERROR: Multiple BLAST databases found in ${path_file}: | ||
| - ${db_names} | ||
| Please specify the exact path to the .nal file you want to use. | ||
| Examples: | ||
| --blastn ${path_file}/${nal_files[0].name} | ||
| --blastn ${path_file}/${nal_files[1].name} | ||
| """ | ||
| } else { | ||
| // Look for .nin files as fallback | ||
| def nin_files = path_file.listFiles().findAll { it.name.endsWith('.nin') } | ||
| if (nin_files.size() == 1) { | ||
| log.info "Found single BLAST database: ${nin_files[0].name}" | ||
| return [path_file, null] // Return directory with no specific db name | ||
| } else if (nin_files.size() > 1) { | ||
| def db_names = nin_files.collect { it.name }.join('\n - ') | ||
| error """ | ||
| ERROR: Multiple BLAST databases found in ${path_file}: | ||
| - ${db_names} | ||
| Please specify the exact path to the .nin file you want to use. | ||
| Examples: | ||
| --blastn ${path_file}/${nin_files[0].name} | ||
| --blastn ${path_file}/${nin_files[1].name} | ||
| """ | ||
| } else { | ||
| error """ | ||
| ERROR: No BLAST database files (.nal or .nin) found in ${path_file} | ||
| Please ensure the directory contains a valid BLAST database or | ||
| specify the direct path to a .nal file. | ||
| Example: --blastn /path/to/databases/nt.nal | ||
| """ | ||
| } | ||
| } | ||
| } else { | ||
| error """ | ||
| ERROR: Invalid database path: ${path_file} | ||
| The path must point to either: | ||
| - A directory containing a single BLAST database | ||
| - A direct path to a .nal file | ||
| Example: --blastn /path/to/databases/nt.nal | ||
| """ | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.