Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update nf-core/tools API docs for dev #2850

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Update nf-core/tools API docs for dev #2850

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions sites/docs/src/content/api_reference/dev/api/pipelines/params-file.md
View file
Open in desktop
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