CI
59f1edaa39
Build pipeline: viash-hub.biobox.update-readme-8tpcp
Source commit: b6dce14faa
Source message: update readme
116 lines
3.6 KiB
Plaintext
116 lines
3.6 KiB
Plaintext
---
|
|
format: gfm
|
|
---
|
|
```{r setup, include=FALSE}
|
|
project <- yaml::read_yaml("_viash.yaml")
|
|
license <- paste0(project$links$repository, "/blob/main/LICENSE")
|
|
contributing <- paste0(project$links$repository, "/blob/main/CONTRIBUTING.md")
|
|
```
|
|
# 🌱📦 `r project$name`
|
|
|
|
[](https://www.viash-hub.com/packages/`r project$name`)
|
|
[](`r project$links$repository`)
|
|
[](`r license`)
|
|
[](`r project$links$issue_tracker`)
|
|
[![Viash version](https://img.shields.io/badge/Viash-v`r gsub("-", "--", project$viash_version)`-blue.svg)](https://viash.io)
|
|
|
|
`r project$summary`
|
|
|
|
## Introduction
|
|
|
|
`r project$description`
|
|
|
|
## Example Usage
|
|
|
|
Viash components in `r project$name` can be run in various ways:
|
|
|
|
```{mermaid}
|
|
flowchart TD
|
|
A[biobox v0.3.0] --> B(Viash Hub Launch)
|
|
A --> C(Viash CLI)
|
|
A --> D(Nextflow CLI)
|
|
A --> E(Seqera Cloud)
|
|
A --> F(As a dependency)
|
|
```
|
|
|
|
### 1. Via the Viash Hub Launch interface
|
|
|
|
You can run this component directly from the Viash Hub [Launch interface](https://www.viash-hub.com/launch?package=biobox&version=v0.3.0&component=arriba&runner=Executable).
|
|
|
|
|
|
|
|
### 2. Via the Viash CLI
|
|
|
|
You can run this component directly from the command line using the Viash CLI.
|
|
|
|
```bash
|
|
viash run vsh://biobox@v0.3.0/arriba -- --help
|
|
|
|
viash run vsh://biobox@v0.3.0/arriba -- \
|
|
--bam path/to/input.bam \
|
|
--genome path/to/genome.fa \
|
|
--gene_annotation path/to/annotation.gtf \
|
|
--fusions path/to/output.txt
|
|
```
|
|
|
|
This will run the component with the specified input files and output the results to the specified output file.
|
|
|
|
### 3. Via the Nextflow CLI or Seqera Cloud
|
|
|
|
You can run this component as a Nextflow pipeline.
|
|
|
|
```bash
|
|
nextflow run https://packages.viash-hub.com/vsh/biobox \
|
|
-revision v0.3.0 \
|
|
-main-script target/nextflow/arriba/main.nf \
|
|
-latest -resume \
|
|
-profile docker \
|
|
--bam path/to/input.bam \
|
|
--genome path/to/genome.fa \
|
|
--gene_annotation path/to/annotation.gtf \
|
|
--publish_dir path/to/output
|
|
```
|
|
|
|
**Note:** Make sure that the [Nextflow SCM](https://www.nextflow.io/docs/latest/git.html#git-configuration) is set up properly. You can do this by adding the following lines to your `~/.nextflow/scm` file:
|
|
|
|
```groovy
|
|
providers.vsh.platform = 'gitlab'
|
|
providers.vsh.server = 'https://packages.viash-hub.com'
|
|
```
|
|
|
|
**Tip:** This will also work with Seqera Cloud or other Nextflow-compatible platforms.
|
|
|
|
### 4. As a dependency
|
|
|
|
In your Viash config file (`config.vsh.yaml`), you can add this component as a dependency:
|
|
|
|
```yaml
|
|
dependencies:
|
|
- name: arriba
|
|
repository: vsh://biobox@v0.3.0
|
|
```
|
|
|
|
**Tip:** See the [Viash documentation](https://viash.io/guide/nextflow_vdsl3/create-a-pipeline.html#pipeline-as-a-component) for more details on how to use Viash components as a dependency in your own Nextflow workflows.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! We aim to build a comprehensive collection of high-quality bioinformatics components. If you'd like to contribute, please follow these general steps:
|
|
|
|
|
|
```{r echo=FALSE}
|
|
lines <- readr::read_lines("CONTRIBUTING.md")
|
|
|
|
index_start <- grep("^### Step [0-9]*:", lines)
|
|
|
|
index_end <- c(index_start[-1] - 1, length(lines))
|
|
|
|
name <- gsub("^### Step [0-9]*: *", "", lines[index_start])
|
|
|
|
knitr::asis_output(
|
|
paste(paste0(" 1. ", name, "\n"), collapse = "")
|
|
)
|
|
```
|
|
|
|
See the [CONTRIBUTING](`r contributing`) file for more details.
|
|
|