Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lukfor committed Oct 21, 2024
1 parent d9117bc commit 7be80ff
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 10 deletions.
3 changes: 1 addition & 2 deletions docs/developers/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,6 @@ workflow:
script: nf-core/taxprofiler
revision: 1.1.8
params:
input: "${input}"
run_kraken2: ${{profiler == "kraken2"}}
run_metaphlan: ${{profiler == "metaphlan"}}
databases: "https://raw.githubusercontent.com/nf-core/test-datasets/taxprofiler/database_full_v1.2.csv"
Expand All @@ -181,7 +180,7 @@ workflow:

Cloudgene supports the connection of multiple pipelines by allowing you to define workflows that consist of multiple steps. Each step can execute a separate pipeline, and the output of one pipeline can be passed as the input to the next.

In this example, Cloudgene connects two Nextflow pipelines (nf-core/fetchngs and nf-core/taxprofiler) into a single workflow, making it easy to fetch data and then run a taxonomic profiler.
In this example, Cloudgene connects two Nextflow pipelines (nf-core/fetchngs and nf-core/taxprofiler) into a single workflow, making it easy to fetch data and then run a taxonomic profiler using the created samplesheet file.

```yaml
id: taxprofiler
Expand Down
10 changes: 2 additions & 8 deletions docs/developers/outputs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Outputs

Output parameters can be used as placeholders for folders or files which are created by steps. Cloudgene supports POSIX compatible filesystems (e.g. Linux or OS X) and the *Hadoop Distributed File System* (HDFS). Cloudgene creates and manages these folders for you as well as enables downloading the files through the web interface.
Output parameters can be used as placeholders for folders or files which are created by steps. Cloudgene creates and manages these folders for you as well as enables downloading the files through the web interface.

Output parameters are defined in the `outputs` section where each parameter is defined by an unique `id`, a textual `description` and a `type`.

```yaml hl_lines="6 7 8 9 10 11"
```yaml hl_lines="6 7 8 9 10"
id: output-example
name: Output Example
version: 1.0
Expand All @@ -13,9 +13,6 @@ workflow:
- id: output
description: Output Folder
type: folder
mergeOutput: false
download: true
zip: false
```
The value of the parameter can be referenced by `$id` in the workflow. In this example, we use the `touch` command to create a file in an output folder:
Expand All @@ -32,9 +29,6 @@ workflow:
- id: output
description: Output Folder
type: folder
mergeOutput: false
download: true
zip: false
```

## Properties
Expand Down

0 comments on commit 7be80ff

Please sign in to comment.