nf-core_modules/modules/ultra/pipeline/functions.nf
Sébastien Guizard 4a9bfec61d
New module: Ultra (#871)
* 👌 IMPROVE: Update .gitignore

* 📦 Add ultra module

* 👌 IMPROVE: Update test input

* 👌 IMPROVE: Update and clean code

- Update to last versions.yml file
- Update meta.yml
- Correct typos

* 👌 IMPROVE: Update output channels + Rename following subtool

* 👌 IMPROVE: Remove old ultre files

* 👌 IMPROVE: Update of pytest_modules.yml

* 👌 IMPROVE: Update test.yml

* 👌 IMPROVE: Keep md5sum as much as possible

* 👌 IMPROVE: Remove old ultra files

* 👌 IMPROVE: Update of pytest_modules.yml

* 👌 IMPROVE: Update test.yml

* 👌 IMPROVE: Keep md5sum as much as possible

* 🐛 Fix: add unsaved modifications

* 🐛 FIX: Remove one inconstant md5sum

* 🐛 FIX: Grab software name using ${getSoftwareName(task.process)}

* 🐛 FIX: Remove md5sums for pickle files (not constant).

* Update modules/ultra/pipeline/main.nf

Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>

* Update modules/ultra/pipeline/main.nf

Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>

* 👌 IMPROVE: update output directory, update meta.yml

* 👌 IMPROVE: Use modules to gunzip and sort gtf

* 🐛 FIX: Set up channel correctly

* 👌 IMPROVE: Remove pickles files and databases

Those data might be useful in a debugging purpose.

* Apply suggestions from code review

* Update main.nf

Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>
2021-11-15 15:57:58 +00:00

78 lines
2.6 KiB
Text

//
// Utility functions used in nf-core DSL2 module files
//
//
// Extract name of software tool from process name using $task.process
//
def getSoftwareName(task_process) {
return task_process.tokenize(':')[-1].tokenize('_')[0].toLowerCase()
}
//
// Extract name of module from process name using $task.process
//
def getProcessName(task_process) {
return task_process.tokenize(':')[-1]
}
//
// Function to initialise default values and to generate a Groovy Map of available options for nf-core modules
//
def initOptions(Map args) {
def Map options = [:]
options.args = args.args ?: ''
options.args2 = args.args2 ?: ''
options.args3 = args.args3 ?: ''
options.publish_by_meta = args.publish_by_meta ?: []
options.publish_dir = args.publish_dir ?: ''
options.publish_files = args.publish_files
options.suffix = args.suffix ?: ''
return options
}
//
// Tidy up and join elements of a list to return a path string
//
def getPathFromList(path_list) {
def paths = path_list.findAll { item -> !item?.trim().isEmpty() } // Remove empty entries
paths = paths.collect { it.trim().replaceAll("^[/]+|[/]+\$", "") } // Trim whitespace and trailing slashes
return paths.join('/')
}
//
// Function to save/publish module results
//
def saveFiles(Map args) {
def ioptions = initOptions(args.options)
def path_list = [ ioptions.publish_dir ?: args.publish_dir ]
// Do not publish versions.yml unless running from pytest workflow
if (args.filename.equals('versions.yml') && !System.getenv("NF_CORE_MODULES_TEST")) {
return null
}
if (ioptions.publish_by_meta) {
def key_list = ioptions.publish_by_meta instanceof List ? ioptions.publish_by_meta : args.publish_by_meta
for (key in key_list) {
if (args.meta && key instanceof String) {
def path = key
if (args.meta.containsKey(key)) {
path = args.meta[key] instanceof Boolean ? "${key}_${args.meta[key]}".toString() : args.meta[key]
}
path = path instanceof String ? path : ''
path_list.add(path)
}
}
}
if (ioptions.publish_files instanceof Map) {
for (ext in ioptions.publish_files) {
if (args.filename.endsWith(ext.key)) {
def ext_list = path_list.collect()
ext_list.add(ext.value)
return "${getPathFromList(ext_list)}/$args.filename"
}
}
} else if (ioptions.publish_files == null) {
return "${getPathFromList(path_list)}/$args.filename"
}
}