Skip to content

Commit

Permalink
update doc for config parts
Browse files Browse the repository at this point in the history
  • Loading branch information
CunliangGeng committed Nov 27, 2024
1 parent 69c80a5 commit ac60bf3
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 12 deletions.
8 changes: 2 additions & 6 deletions docs/concepts/config_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,9 @@
--8<-- "src/nplinker/data/nplinker.toml"
```

## Example Configuration

## Default Configurations
The default configurations are automatically used by NPLinker if you don't set them in your config file.

```toml
--8<-- "src/nplinker/nplinker_default.toml"
```
For a full example of a configuration file, see [here](../quickstart.md#3-prepare-config-file).

## Config loader

Expand Down
38 changes: 32 additions & 6 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,16 +166,27 @@ is recommended to put it in the working directory created in step 2.

The details of all settings can be found at this page [Config File](./concepts/config_file.md).

To keep it simple, [default settings](./concepts/config_file.md#default-configurations) will be used
automatically by NPLinker if you don't set them in your `nplinker.toml` config file.

What you need to do is to set the `root_dir` and `mode` in the `nplinker.toml` file.
Here are some example values for the `nplinker.toml` file:

=== "`local` mode"
```toml title="nplinker.toml"
root_dir = "absolute/path/to/working/directory" # (1)!
mode = "local"
# and other settings you want to override the default settings

[log]
level = "DEBUG"
use_console = true

[mibig]
to_use = true
version = "3.1"

[bigscape]
version = 1
cutoff = "0.30"

[scoring]
methods = ["metcalf"]
```

1. Replace `absolute/path/to/working/directory` with the **absolute** path to the working directory
Expand All @@ -187,7 +198,22 @@ What you need to do is to set the `root_dir` and `mode` in the `nplinker.toml` f
root_dir = "absolute/path/to/working/directory" # (1)!
mode = "podp"
podp_id = "podp_id" # (2)!
# and other settings you want to override the default settings

[log]
level = "DEBUG"
use_console = true

[mibig]
to_use = true
version = "3.1"

[bigscape]
version = 2
cutoff = "0.30"
parameters = "--mibig_version 3.1 --include_singletons --gcf_cutoffs 0.30"

[scoring]
methods = ["metcalf"]
```

1. Replace `absolute/path/to/working/directory` with the **absolute** path to the working directory
Expand Down

0 comments on commit ac60bf3

Please sign in to comment.