Skip to content

Commit

Permalink
updating to v0.2.3
Browse files Browse the repository at this point in the history
  • Loading branch information
mtisza1 committed Jul 5, 2023
1 parent b0948f4 commit e5911da
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 21 deletions.
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,7 @@ Virus genomes or segments are considered "detected" if:

`EsViritu -h`

3) (OPTIONAL BUT RECOMMENDED) Install the `R` package `dataui` manually in an R session. Without `dataui` reports won't show genome coverage sparklines.

`R`

then:

`remotes::install_github("timelyportfolio/dataui")`

4) Download the database in the `Esviritu` directory (\~300 MB when decompressed).
3) Download the database (\~300 MB when decompressed).

`cd EsViritu` *or `cd` where you want the database to reside*

Expand All @@ -72,10 +64,18 @@ should return `8e207e6a9465d7e40e948d7559b014c4`

DB files should be in `DBs/v2.0.2`

5) Set the database path:
4) Set the database path:

`conda env config vars set ESVIRITU_DB=/path/to/DBs/v2.0.2`

5) (OPTIONAL BUT RECOMMENDED) Install the `R` package `dataui` manually in an R session. Without `dataui` reports won't show genome coverage sparklines.

`R`

then:

`remotes::install_github("timelyportfolio/dataui")`

### Developmental verision

1) Clone repo
Expand All @@ -98,15 +98,8 @@ DB files should be in `DBs/v2.0.2`

`pip install .`

6) (OPTIONAL BUT RECOMMENDED) Install the `R` package `dataui` manually in an R session. Without `dataui` reports won't show genome coverage sparklines.

`R`

then:

`remotes::install_github("timelyportfolio/dataui")`

7) Download the database in the `Esviritu` directory (\~300 MB when decompressed).
6) Download the database (\~300 MB when decompressed).

`cd EsViritu` *or `cd` where you want the database to reside*

Expand All @@ -122,10 +115,18 @@ should return `8e207e6a9465d7e40e948d7559b014c4`

DB files should be in `DBs/v2.0.2`

8) Set the database path:
7) Set the database path:

`conda env config vars set ESVIRITU_DB=/path/to/DBs/v2.0.2`

8) (OPTIONAL BUT RECOMMENDED) Install the `R` package `dataui` manually in an R session. Without `dataui` reports won't show genome coverage sparklines.

`R`

then:

`remotes::install_github("timelyportfolio/dataui")`

## (OPTIONAL) Database for filtering out host reads and spike-ins

You could filter unwanted sequences out upstream of this tool, but this will allow you to do it within `EsViritu` using `minimap2`. The pipeline script will look for a file at `filter_seqs/filter_seqs.fna` which could be any fasta-formatted sequence file you want to use to remove matching reads (e.g. from host or spike-in).
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "EsViritu"
version = "0.2.2"
version = "0.2.3"
authors = [
{ name="Mike Tisza", email="[email protected]" },
]
Expand Down
2 changes: 1 addition & 1 deletion src/EsViritu/EsViritu.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def str2bool(v):
esviritu_script_path = os.path.abspath(pathname)
print(esviritu_script_path)

__version__='0.2.2'
__version__='0.2.3'

def EsViritu():
parser = argparse.ArgumentParser(description='EsViritu is a read mapping pipeline for detection and measurement of human and animal virus pathogens from short read metagenomic or clinical samples. Version ' + str(__version__))
Expand Down

0 comments on commit e5911da

Please sign in to comment.