You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage/extension.md
+13-17Lines changed: 13 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,14 +18,23 @@ The plugin provides some [extension points](https://nextflow.io/docs/latest/plug
18
18
19
19
In CLI/extension post-run mode, workflow metadata is reconstructed using the trace file (e.g., start/end time, duration) and synthetic/runtime values (e.g., run name, command line), and may differ from reports generated during an integrated plugin run.
20
20
21
+
#### Shared arguments
22
+
23
+
Both modes accept the following arguments:
24
+
25
+
-**tracePath***(required)*: Path to the execution trace file.
26
+
-**delimiter**: Column separator used in the trace file. Defaults to `'\t'`.
27
+
21
28
#### From the command line
22
29
The command line functionality utilizes Nextflow configs, like the regular plugin (see [parameters.md](./parameters.md)).
23
30
It is recommended to set the output paths and a fixed carbon intensity value (`ci`) in the config.
In addition to the [shared arguments](#shared-arguments):
28
36
37
+
-**--config**: Path to a Nextflow config file (output paths, carbon intensity, etc.).
29
38
30
39
#### Within a workflow through functions
31
40
The interaction follows the [Nextflow extension function schema](https://nextflow.io/docs/latest/plugins/developing-plugins.html#functions).
@@ -58,23 +67,10 @@ workflow {
58
67
59
68
##### Functions
60
69
###### `parseTraceFile`
61
-
Parse the trace file into a list of TraceRecord instances.
62
-
63
-
-**tracePath**:
64
-
Path to a trace file
65
-
66
-
-**delimiter**:
67
-
Deliming character of the tabular trace file. Defaults to `'\t'`.
70
+
Parse the trace file into a list of TraceRecord instances. Accepts the [shared arguments](#shared-arguments).
68
71
69
72
###### `calculateCO2`
70
-
Can be used to calculate the emissions of a trace.
71
-
72
-
-**tracePath**:
73
-
Path to the trace file
73
+
Calculate the emissions of a trace. Accepts the [shared arguments](#shared-arguments), plus:
74
74
75
-
-**configModifications**:
76
-
Temporarily overrides parameters in the `co2footprint` block of the current Nextflow configuration for a single extension function call. The provided map is merged with the existing configuration and does not affect the overall workflow run. Can be used to adjust settings such as output paths or carbon intensity for post-run estimations. Defaults to [:].
75
+
-**configModifications**: Temporarily overrides parameters in the `co2footprint` block of the current Nextflow configuration for this call. The provided map is merged with the existing configuration and does not affect the overall workflow run. Defaults to `[:]`.
0 commit comments