Skip to content

Commit

Permalink
Merge pull request #2850 from nf-core/update-api-docs-dev
Browse files Browse the repository at this point in the history
Update nf-core/tools API docs for dev
  • Loading branch information
mashehu authored Nov 12, 2024
2 parents adda03a + 35dad07 commit b9e3bf7
Showing 1 changed file with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Class to hold config option to launch a pipeline.
- **pipeline** (_str_ _,_ _optional_) – Path to a local pipeline path or a remote pipeline.
- **revision** (_str_ _,_ _optional_) – Revision of the pipeline to use.

#### `format_group(definition, show_hidden=False){:python}`
#### `format_group(definition, show_hidden=False) → str{:python}`

Format a group of parameters of the schema as commented YAML.

Expand All @@ -24,7 +24,7 @@ Format a group of parameters of the schema as commented YAML.
- **Return type:**
str

#### `format_param(name, properties, required_properties=(), show_hidden=False){:python}`
#### `format_param(name: str, properties: Dict, required_properties: List[str] = [], show_hidden: bool = False) → str | None{:python}`

Format a single parameter of the schema as commented YAML

Expand All @@ -39,7 +39,7 @@ Format a single parameter of the schema as commented YAML
- **Return type:**
str

#### `generate_params_file(show_hidden=False){:python}`
#### `generate_params_file(show_hidden: bool = False) → str{:python}`

Generate the contents of a parameter template file.

Expand All @@ -52,11 +52,11 @@ Assumes the pipeline has been fetched (if remote) and the schema loaded.
- **Return type:**
str

#### `get_pipeline(){:python}`
#### `get_pipeline() → bool | None{:python}`

Prompt the user for a pipeline name and get the schema

#### `write_params_file(output_fn='nf-params.yaml', show_hidden=False, force=False){:python}`
#### `write_params_file(output_fn: Path = PosixPath('nf-params.yaml'), show_hidden=False, force=False) → bool{:python}`

Build a template file for the pipeline schema.

Expand All @@ -69,7 +69,7 @@ Build a template file for the pipeline schema.
- **Return type:**
bool

### `nf_core.pipelines.params_file._print_wrapped(text, fill_char='-', mode='both', width=80, indent=0, drop_whitespace=True){:python}`
### `nf_core.pipelines.params_file._print_wrapped(text, fill_char='-', mode='both', width=80, indent=0, drop_whitespace=True) → str{:python}`

Helper function to format text for the params-file template.

Expand Down

0 comments on commit b9e3bf7

Please sign in to comment.