Skip to content

Commit

Permalink
Change refactor to main in links (#287)
Browse files Browse the repository at this point in the history
  • Loading branch information
Adoni5 committed Oct 11, 2023
1 parent f058cdd commit afd0c7e
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ See '<command> --help' to read about a specific sub-command.
TOML File
---------
For information on the TOML files see [TOML.md](docs/toml.md).
There are several example TOMLS, with comments explaining what each field does, as well as the overall purpose of the [TOML file here](https://github.com//LooseLab/readfish/tree/refactor/docs/_static/example_tomls) .
There are several example TOMLS, with comments explaining what each field does, as well as the overall purpose of the [TOML file here](https://github.com//LooseLab/readfish/tree/main/docs/_static/example_tomls) .

<details style="margin-top: 10px; margin-bottom: 10px" open><summary id="testing"><h1 style="display: inline">Testing</h1></summary>
<!-- begin-test -->
Expand Down
4 changes: 2 additions & 2 deletions docs/developers-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Readfish uses [calver](https://calver.org/) for versioning. Specifically the for


## Viewing Documentation
Aside from a traditional [`README.md`](https://github.com/LooseLab/readfish/blob/refactor/README.md), `readfish` uses [`sphinx`](https://www.sphinx-doc.org/en/master/) to create documentation.
Aside from a traditional [`README.md`](https://github.com/LooseLab/readfish/blob/main/README.md), `readfish` uses [`sphinx`](https://www.sphinx-doc.org/en/master/) to create documentation.
All documentation is kept in the `readfish/docs` directory.

A live version is available at https://looselab.github.io/readfish/.
Expand Down Expand Up @@ -133,7 +133,7 @@ Currently, two types of plugins can be written
- `Caller` plugins (must inherit `CallerABC`), which wrap a base caller for calling chunks
- `Aligner` plugins (must inherit `AlignerABC`), which wrap an aligner for making decisions on base called chunks.

These ABCs are defined in [`abc.py`](https://github.com/LooseLab/readfish/blob/refactor/src/readfish/plugins/abc.py).
These ABCs are defined in [`abc.py`](https://github.com/LooseLab/readfish/blob/main/src/readfish/plugins/abc.py).
This means that the methods which are used in `targets.py` are present, so plugins can be swapped out at run time, and function as standardised self-contained interfaces to different external tools.

If a plugin module is written and not included in `readfish` package, but another, it is possible to include it by passing the path in the `toml`.
Expand Down
2 changes: 1 addition & 1 deletion docs/questions/creating_readfish-environment.question.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ dependencies:
- pip:
- git+https://github.com/nanoporetech/read_until_api@3.4.1
- ont-pyguppy-client-lib==X.X.X
- git+https://github.com/LooseLab/readfish@refactor
- git+https://github.com/LooseLab/readfish@main
```
2 changes: 1 addition & 1 deletion docs/questions/readfish-branches.question.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ alt_titles:
- "Suitable readfish branch"
---

The `refactor` branch is the most up to date branch of readfish, and is the one we recommend using.
The `main` branch is the most up to date branch of readfish, and is the one we recommend using.
Watch this space for any updates!
See elsewhere in this file for installation FAQs. 🕵️‍♂️
2 changes: 1 addition & 1 deletion docs/toml.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Readfish experiments are configured using [TOML] files, which are minimal and easy-to-read markup files.
Our configuration only uses [tables] and [arrays of tables] populated with [key-value pairs].
The TOML file contains almost all the information required for running readfish, such as information on barcodes, control/analysis regions, what basecaller or aligner to use.
There are several example TOMLS, with comments explaining what each field does, as well as the overall purpose of the TOML file here - https://github.com//LooseLab/readfish/tree/refactor/docs/_static/example_tomls.
There are several example TOMLS, with comments explaining what each field does, as well as the overall purpose of the TOML file here - https://github.com//LooseLab/readfish/tree/main/docs/_static/example_tomls.
## Data model

To understand each section of the TOML file it helps to understand the work that readfish does:
Expand Down

0 comments on commit afd0c7e

Please sign in to comment.