Skip to content

Commit 52bade7

Browse files
authored
chore: fix broken docs links (#283)
1 parent 68c8049 commit 52bade7

File tree

8 files changed

+15
-15
lines changed

8 files changed

+15
-15
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ toolchest.kraken2(
2929
)
3030
```
3131

32-
For a list of available tools, see the [documentation](https://docs.trytoolchest.com/docs#-tools).
32+
For a list of available tools, see the [documentation](https://docs.trytoolchest.com/tool-reference/about/).
3333

3434
## Configuration
3535

docs/docs/tool-reference/aligners/bowtie-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Function Arguments
2121
| :----------------- | :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2222
| `inputs` | `-U` | Path to one or more files to use as input. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
2323
| `output_path` | `-S` | (optional) Path (directory) to where the output files will be downloaded. If omitted, skips download. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
24-
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Bowtie 2. This should be a string of arguments like the command line. See [Supported Additional Arguments](https://docs.trytoolchest.com/docs/bowtie-2#supported-additional-arguments) for more details. |
24+
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Bowtie 2. This should be a string of arguments like the command line. See [Supported Additional Arguments](#supported-additional-arguments) for more details. |
2525
| `database_name` | `-x`\* | (optional) Name of database to use for Bowtie 2 alignment. Defaults to `"GRCh38_noalt_as"` (human genome). |
2626
| `database_version` | `-x`\* | (optional) Version of database to use for Bowtie 2 alignment. Defaults to `"1"`. |
2727
| `is_async` | | Whether to run a job asynchronously. See [Async Runs](../../feature-reference/async-runs.md) for more. |

docs/docs/tool-reference/aligners/clustal-omega.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ See the Notes section below for more details.
2222
| :------------ | :------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2323
| `inputs` | `-i` | Path to one or more files to use as input. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
2424
| `output_path` | `-o` | (optional) Path (directory) to where the output files will be downloaded. If omitted, skips download. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
25-
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Clustal Omega. This should be a string of arguments like the command line. See [Supported Additional Arguments](https://docs.trytoolchest.com/docs/clustal-omega#supported-additional-arguments) for more details. |
25+
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Clustal Omega. This should be a string of arguments like the command line. See [Supported Additional Arguments](#supported-additional-arguments) for more details. |
2626
| `is_async` | | Whether to run a job asynchronously. See [Async Runs](../../feature-reference/async-runs.md) for more. |
2727

2828
Tool Versions

docs/docs/tool-reference/aligners/rapsearch2.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ Function Arguments
2121

2222
See the Notes section below for more details.
2323

24-
| Argument | Use in place of: | Description |
25-
| :----------------- | :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
26-
| `inputs` | `-q` | Path to one or more files to use as input. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
27-
| `output_path` | `-o` | (optional) Path (directory) to where the output files will be downloaded. If omitted, skips download. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
28-
| `database_name` | `-d`\* | (optional) Name of database to use for RAPSearch2 alignment. Defaults to `"GRCh38"` (human genome). |
29-
| `database_version` | `-d`\* | (optional) Version of database to use for RAPSearch2 alignment. Defaults to `"1"`. |
30-
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to RAPSearch2. This should be a string of arguments like the command line. See [Supported Additional Arguments](https://docs.trytoolchest.com/docs/rapsearch-2#supported-additional-arguments) for more details. |
31-
| `is_async` | | Whether to run a job asynchronously. See [Async Runs](../../feature-reference/async-runs.md) for more. |
24+
| Argument | Use in place of: | Description |
25+
| :----------------- | :------------------ |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
26+
| `inputs` | `-q` | Path to one or more files to use as input. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
27+
| `output_path` | `-o` | (optional) Path (directory) to where the output files will be downloaded. If omitted, skips download. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
28+
| `database_name` | `-d`\* | (optional) Name of database to use for RAPSearch2 alignment. Defaults to `"GRCh38"` (human genome). |
29+
| `database_version` | `-d`\* | (optional) Version of database to use for RAPSearch2 alignment. Defaults to `"1"`. |
30+
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to RAPSearch2. This should be a string of arguments like the command line. See [Supported Additional Arguments](#supported-additional-arguments) for more details. |
31+
| `is_async` | | Whether to run a job asynchronously. See [Async Runs](../../feature-reference/async-runs.md) for more. |
3232

3333
\*See the [Databases](#databases) section for more details.
3434

docs/docs/tool-reference/assemblers/unicycler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Function Arguments
2424
| `read_two` | `-2` | (optional) Path to R2 of paired-end short read input files. The file can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
2525
| `long_reads` | `-l` | (optional) Path to the file containing long reads. The file can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
2626
| `output_path` | `-o` | (optional) Path (directory) to where the output files will be downloaded. If omitted, skips download. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
27-
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Unicycler. This should be a string of arguments like the command line. See [Supported Additional Arguments](https://docs.trytoolchest.com/docs/unicycler#supported-additional-arguments) for more details. |
27+
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Unicycler. This should be a string of arguments like the command line. See [Supported Additional Arguments](#supported-additional-arguments) for more details. |
2828
| `is_async` | | Whether to run a job asynchronously. See [Async Runs](../../feature-reference/async-runs.md) for more. |
2929

3030
Notes

docs/docs/tool-reference/post-processing/bracken.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ tc.bracken(
2323
| `kraken2_report` | Kraken 2 report file input | Path to Kraken 2 report file. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
2424
| `output_path` | `-o` directory name | (optional) Path (directory) to where the output files will be downloaded. If omitted, skips download. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
2525
| `output_primary_name` | `-o` file name | (Optional) Name of Bracken output file. Defaults to `"output.bracken"`. |
26-
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Bracken. This should be a string of arguments like the command line. See [Supported Additional Arguments](https://docs.trytoolchest.com/docs/kraken-2#supported-additional-arguments) for more details. |
26+
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Bracken. This should be a string of arguments like the command line. See [Supported Additional Arguments](#supported-additional-arguments) for more details. |
2727
| `database_name` | `-d` | (optional) Name of database that was used for Kraken 2 alignment. Defaults to `"standard"`. |
2828
| `database_version` | `-d` | (optional) Version of database that was used for Kraken 2 alignment. Defaults to `"1"`. |
2929
| `remote_database_path` | `-d` | (optional) AWS S3 URI to a directory with your custom database that was used with Kraken 2 alignment. |

docs/docs/tool-reference/structure-prediction/alphafold.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@ Toolchest supports the following arguments for AlphaFold:
5252
- `--max_template_date`
5353
- `--model_preset`
5454

55-
However, these should be specified via specific argument values in the function call, rather than through a generic `tool_args` argument (like other Toolchest tools). See [Function Arguments](https://docs.trytoolchest.com/docs/alphafold#function-arguments) for more details.
55+
However, these should be specified via specific argument values in the function call, rather than through a generic `tool_args` argument (like other Toolchest tools). See [Function Arguments](#function-arguments) for more details.

docs/docs/tool-reference/taxonomic-classifiers/kraken-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ tc.kraken2(
2525
| `read_one` | `--paired`, input file location | (optional) Path to R1 of paired-end read input files. The file can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
2626
| `read_two` | `--paired`, input file location | (optional) Path to R2 of paired-end read input files. The file can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
2727
| `output_path` | output file location | (optional) Path (directory) to where the output files will be downloaded. If omitted, skips download. The files can be a local or remote, see [Using Files](../../getting-started/using-files.md). |
28-
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Kraken 2. This should be a string of arguments like the command line. See [Supported Additional Arguments](https://docs.trytoolchest.com/docs/kraken-2#supported-additional-arguments) for more details. |
28+
| `tool_args` | all other arguments | (optional) Additional arguments to be passed to Kraken 2. This should be a string of arguments like the command line. See [Supported Additional Arguments](#supported-additional-arguments) for more details. |
2929
| `database_name` | `--db` | (optional) Name of database to use for Kraken 2 alignment. Defaults to `"standard"`. |
3030
| `database_version` | `-db` | (optional) Version of database to use for Kraken 2 alignment. Defaults to `"1"`. |
3131
| `remote_database_path` | `-db` | (optional) AWS S3 URI to a directory with your custom database. |

0 commit comments

Comments
 (0)