Skip to content

Commit

Permalink
Feature config (#69)
Browse files Browse the repository at this point in the history
* add build to ci pages

* add coming soon template to a new file

* plot and query configuration
  • Loading branch information
vestalisvirginis committed May 29, 2024
1 parent 6264248 commit 55e6204
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ jobs:
with:
python-version: 3.x
- run: pip install mkdocs-material mkdocstrings[python]
#- run: mkdocs build
- run: mkdocs build
- run: mkdocs gh-deploy --force
8 changes: 8 additions & 0 deletions docs/coming_soon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Coming Soon

We’re working hard to make this page available by the end of June!

Until then we look forward to your questions and feedbacks using the [Discussions](https://github.com/vestalisvirginis/synphage/discussions) or the [Issues](https://github.com/vestalisvirginis/synphage/issues) pages.
Please follow the [How to contribute?](https://github.com/vestalisvirginis/synphage/blob/main/CONTRIBUTING.md) guidelines for any contribution to this project!

We are looking forward to hearing from you!
41 changes: 36 additions & 5 deletions docs/configurations.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,39 @@
# Coming Soon
# Configurations

We’re working hard to make this page available by the end of June!
Using Dagster to run synphage pipeline allows the user to easily configure the jobs at run-time.

Until then we look forward to your questions and feedbacks using the [Discussions](https://github.com/vestalisvirginis/synphage/discussions) or the [Issues](https://github.com/vestalisvirginis/synphage/issues) pages.
Please follow the [How to contribute?](https://github.com/vestalisvirginis/synphage/blob/main/CONTRIBUTING.md) guidelines for any contribution to this project!

We are looking forward to hearing from you!
## Plotting config options

To change the plot configations, open the dropdown menu at the right of the `Materialize all` black button. Then go to `Open launchpad`. This will open a pop-up window with the configurations.

List of the supported configurations:

1. Genome selection

Field Name | Description | Default Value
------- | ----------- | ----
`sequence_file` | File containing the plot instruction | sequences.csv

2. Graphic

Field Name | Description | Default Value
------- | ----------- | ----
`title` | Generated plot file title | synteny_plot
`colours` | Gene identity colour bar | ["#fde725", "#90d743", "#35b779", "#21918c", "#31688e", "#443983", "#440154"]
`gradient` | Nucleotide identity colour bar | #B22222
`graph_shape` | Linear or circular representation | linear
`graph_pagesize` | Output document format | A4
`graph_fragments` | Number of fragments | 1
`graph_start` | Sequence start | 1
`graph_end` | Sequence end | length of the longest genome


## Query config options

To change the query configations, open the dropdown menu at the right of the `Materialize all` black button. Then go to `Open launchpad`. This will open a pop-up window with the configurations.

Field Name | Description | Default Value
------- | ----------- | ----
`search_key` | Keyword(s) for NCBI query | Myoalterovirus
`database` | Database identifier | nuccore

0 comments on commit 55e6204

Please sign in to comment.