update documentation

Signed-off-by: Bastian Eisenmann <bastian.eisenmann@uni-tuebingen.de>
nextflow-io · Dec 19, 2024 · 6fbd4fe · 6fbd4fe
1 parent a9d6bc8
commit 6fbd4fe
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md
@@ -8,7 +8,7 @@ description: Configuration of the nf-co2footprint plugin
 ## General usage
 To test if the plugin works on your system please follow the quick start guide ([Quick Start](https://nextflow-io.github.io/nf-co2footprint/#quick-start)) on a small pipeline like [nextflow-io/hello](https://github.com/nextflow-io/hello).
 
-If the plugin works and a html report is being produced you can start making the output meaningful for your specific run, by using a customized configuration file. The configuration file could look something like this:
+You can adjust the nf-co2footprint plugin parameters in your config file as follows:
 
 ```groovy title="nextflow.config"
 plugins {

diff --git a/docs/usage/output.md b/docs/usage/output.md
@@ -7,9 +7,9 @@ description: Output of the nf-co2footprint plugin.
 
 The nf-co2footprint plugin creates three output files:
 
-- `traceFile`: The trace file includes calculations for each task. Similar to the nextflow trace file. Within this file you can find resource usage details of specific tasks and also the hardware information of your CPU.
+- `traceFile`: The trace file includes calculations for each task, similar to the Nextflow trace file. Within this file you can find resource usage details of specific tasks and also the hardware information of your CPU.
 - `summaryFile`: The summary file includes the total CO<sub>2</sub> footprint of the workflow run and the configuration used for the plugin.
-- `reportFile`: The html report file includes data from trace and summary file and also summary figures of the executed tasks.
+- `reportFile`: The HTML report contains information about the carbon footprint of the whole pipeline run as well as plots showing the distributions of the CO<sub>2</sub> emissions for the different processes. Additionally, it contains a table with the metrics for all individual tasks.