modules/rclone_checksum

Check files in a destination path against a checksum SUM file

checksummd5sha1cloudsync

https://github.com/nf-core/modules/[...]/modules/nf-core/rclone/checksum

Description

Check files in a destination path against a checksum SUM file

Input

name:type

description

pattern

`meta`
`:map`

Groovy Map containing checksum source information e.g. [ id:‘test’ ]

`sumfile`
`:file`

Checksum SUM file containing hashes and destination paths to verify.

*.{md5,sha1,sha256,sum,txt}

`hash`
`:string`

Hash type to check, for example MD5, SHA1, or SHA256.

`destination`
`:string`

Directory containing destination files to check against the SUM file. This should be the fully resolved target path understood by Rclone, such as a local path or a configured remote path. The module does not append sample IDs, basenames, or modify this path internally. Examples: results/output, s3:bucket/output, gs:bucket/output, remote:path/to/output.

`rclone_config`
`:file`

Rclone configuration file defining the remotes used by source_path and/or destination_path. Authentication and remote-specific options should be configured in this file where possible.

*.conf

Output

name:type

description

pattern

`combined`

`meta`
`:map`

Groovy Map containing checksum source information e.g. [ id:‘test’ ]

`${prefix}.combined.txt`
`:file`

Combined report of matching, missing, differing, and error paths.

*.combined.txt

`differ`

`meta`
`:map`

Groovy Map containing checksum source information e.g. [ id:‘test’ ]

`${prefix}.differ.txt`
`:file`

Report of paths present in both source SUM file and destination but different.

*.differ.txt

`missing_on_dst`

`meta`
`:map`

Groovy Map containing checksum source information e.g. [ id:‘test’ ]

`${prefix}.missing_on_dst.txt`
`:file`

Report of paths present in the SUM file but missing from the destination.

*.missing_on_dst.txt

`missing_on_src`

`meta`
`:map`

Groovy Map containing checksum source information e.g. [ id:‘test’ ]

`${prefix}.missing_on_src.txt`
`:file`

Report of paths present in the destination but missing from the SUM file.

*.missing_on_src.txt

`match`

`meta`
`:map`

Groovy Map containing checksum source information e.g. [ id:‘test’ ]

`${prefix}.match.txt`
`:file`

Report of matching paths.

*.match.txt

`error`

`meta`
`:map`

Groovy Map containing checksum source information e.g. [ id:‘test’ ]

`${prefix}.error.txt`
`:file`

Report of paths with read or hash errors.

*.error.txt

`versions_rclone`

`${task.process}`
`:string`

The name of the process

`rclone`
`:string`

The name of the tool

`rclone --version | sed -n '1s/^rclone v//p'`
`:eval`

The expression to obtain the version of the tool

`exit_code`

`meta`
`:map`

Groovy Map containing checksum source information e.g. [ id:‘test’ ]

`${prefix}.exit_code.txt`
`:file`

File with exit status.

*.exit_code.txt

Topics

name:type

description

pattern

`versions`

`${task.process}`
`:string`

The name of the process

`rclone`
`:string`

The name of the tool

`rclone --version | sed -n '1s/^rclone v//p'`
`:eval`

The expression to obtain the version of the tool

Tools

rclone
MIT

Rclone is a command-line program to manage files on cloud storage.

rclone.org rclone.org/commands/rclone_checksum https://github.com/rclone/rclone

modules/rclone_checksum

Description

Input

meta :map

sumfile :file

hash :string

destination :string

rclone_config :file

Output

combined

meta :map

${prefix}.combined.txt :file

differ

meta :map

${prefix}.differ.txt :file

missing_on_dst

meta :map

${prefix}.missing_on_dst.txt :file

missing_on_src

meta :map

${prefix}.missing_on_src.txt :file

match

meta :map

${prefix}.match.txt :file

error

meta :map

${prefix}.error.txt :file

versions_rclone

${task.process} :string

rclone :string

rclone --version | sed -n '1s/^rclone v//p' :eval

exit_code

meta :map

${prefix}.exit_code.txt :file

Topics

versions

${task.process} :string

rclone :string

rclone --version | sed -n '1s/^rclone v//p' :eval

Tools

rcloneMIT

included in

maintainer

get in touch

`meta`
`:map`

`sumfile`
`:file`

`hash`
`:string`

`destination`
`:string`

`rclone_config`
`:file`

`combined`

`meta`
`:map`

`${prefix}.combined.txt`
`:file`

`differ`

`meta`
`:map`

`${prefix}.differ.txt`
`:file`

`missing_on_dst`

`meta`
`:map`

`${prefix}.missing_on_dst.txt`
`:file`

`missing_on_src`

`meta`
`:map`

`${prefix}.missing_on_src.txt`
`:file`

`match`

`meta`
`:map`

`${prefix}.match.txt`
`:file`

`error`

`meta`
`:map`

`${prefix}.error.txt`
`:file`

`versions_rclone`

`${task.process}`
`:string`

`rclone`
`:string`

`rclone --version | sed -n '1s/^rclone v//p'`
`:eval`

`exit_code`

`meta`
`:map`

`${prefix}.exit_code.txt`
`:file`

`versions`

`${task.process}`
`:string`

`rclone`
`:string`

`rclone --version | sed -n '1s/^rclone v//p'`
`:eval`

rclone
MIT