Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.0%) to scientific vocabulary
Repository
A nextflow pipeline wrapping rclone
Basic Info
- Host: GitHub
- Owner: nf-modules-hub
- License: mit
- Language: Nextflow
- Default Branch: main
- Size: 14.6 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
Nextflow wrapper for rclone process.
This little wrapper is designed to be used with orchestrator systems (HPC, K8s) which have a designated copy queue or node.
Pre-requisites
- Nextflow
- Conda
NOTE If you plan to setup a basic server, then you can refer minimal-nextflow-setup
:warning: Conda or local setup only: Due to the nature of mounting files in a container, which involves a lot of copy/symlinks overheads, this wrapper assumes that you are using
rcloneinstalled in a location shared across all nodes.:heavycheckmark: Please ensure that your
$HOME/.config/rclone/rclone.conffile is populated with the correct details of any remotes. For more information please refer the rclone documentation
Usage
nextflow pull https://github.com/nf-modules-hub/rclone
Options
Transfering single files/folder using source and target
To transfer a specific file/folder from any source location to a target location, you can rely upon the source and target parameters.
nextflow run https://github.com/nf-modules-hub/rclone --source /path/to/source --target /path/to/target
Transfering bulk files/folder using samplesheet
To transfer a specific file/folder from any source location to a target location, you can rely upon the samplesheet parameter.
The structure of samplesheet is very minimal since it only requires source and target columns as shown below
csv
source,target
/path/to/a_file,registered-remote:/destination/path/to/a_file
/path/to/a_folder,registered-remote:/destination/path/to/a_folder
Then refer that while invoking the pipeline
nextflow run https://github.com/nf-modules-hub/rclone --samplesheet /path/to/samplesheet
Customizing the script
To customize these scripts, you can take a look at the available parameters in ./nextflow.config file and then override them using a local config file, in a directory where you'd like to launch the pipeline.
Citation
Please use the Github citation page to cite this wrapper in your research.
Contribution
The sole purpose of process wrappers in nf-modules-hub is to keep the code small, clean and hackable with some basic knowledge of nextflow scripting.
If you have specific requirements, you are encouraged to fork/clone and update your version to accomodate your needs.
Contribution, in all forms, is most welcome!
Owner
- Name: nf-hub-modules
- Login: nf-modules-hub
- Kind: organization
- Repositories: 10
- Profile: https://github.com/nf-modules-hub
A central hub for production ready nextflow modules - an initiative by biosharp.net
Citation (CITATION.cff)
#https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Sharma" given-names: "Abhinav" orcid: "https://orcid.org/0000-0002-6402-6993" title: "nf-modules-hub/rclone" version: 1.0.0 #doi: 10.5281/zenodo.1234 date-released: 2023-08-10 url: "https://github.com/nf-modules-hub/rclone/new/master"