rdrpcatch 0.0.8__py3-none-any.whl → 0.0.9__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
rdrpcatch/cli/args.py CHANGED
@@ -76,7 +76,7 @@ def cli():
76
76
  " TSA_Olendraite_fam, TSA_Olendraite_gen, RDRP-scan,Lucaprot_HMM, Zayed_HMM, all, none. ")
77
77
  @click.option("--custom-dbs",
78
78
  help="Path to directory containing custom MSAs/pHMM files to use as additional databases")
79
- @click.option("-seq_type", "--seq_type",
79
+ @click.option("-seq-type", "--seq-type",
80
80
  type=click.STRING,
81
81
  default=None,
82
82
  help="Type of sequence to search against: (prot,nuc) Default: unknown")
@@ -107,11 +107,11 @@ def cli():
107
107
  type=click.INT,
108
108
  default=1,
109
109
  help="Number of CPUs to use for HMMsearch. (default: 1)")
110
- @click.option('-length_thr', '--length_thr',
110
+ @click.option('-length-thr', '--length-thr',
111
111
  type=click.INT,
112
112
  default=400,
113
113
  help="Minimum length threshold for seqkit seq. (default: 400)")
114
- @click.option('-gen-code', '--gen_code',
114
+ @click.option('-gen-code', '--gen-code',
115
115
  type=click.INT,
116
116
  default=1,
117
117
  help='Genetic code to use for translation. (default: 1) Possible genetic codes (supported by seqkit translate) : 1: The Standard Code, '
@@ -142,7 +142,7 @@ def cli():
142
142
  is_flag=True,
143
143
  default=False,
144
144
  help="Bundle the output files into a single archive. (default: False)")
145
- @click.option('-keep-tmp', '--keep_tmp',
145
+ @click.option('-keep-tmp', '--keep-tmp',
146
146
  is_flag=True,
147
147
  default=False,
148
148
  help="Keep temporary files (Expert users) (default: False)")
@@ -237,7 +237,7 @@ def run_scan(input_file, output_dir, db_options, db_dir, custom_dbs, seq_type,
237
237
  elif db == "NeoRdRp".lower():
238
238
  db_name_list.append("NeoRdRp")
239
239
  db_path_list.append(neordrp_hmm_db)
240
- elif db == "NeoRdRp.2.1":
240
+ elif db == "NeoRdRp.2.1".lower():
241
241
  db_name_list.append("NeoRdRp.2.1".lower())
242
242
  db_path_list.append(neordrp_2_hmm_db)
243
243
  elif db == "TSA_Olendraite_fam".lower():
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: rdrpcatch
3
- Version: 0.0.8
3
+ Version: 0.0.9
4
4
  Dynamic: Summary
5
5
  Project-URL: Home, https://github.com/dimitris-karapliafis/RdRpCATCH
6
6
  Project-URL: Source, https://github.com/dimitris-karapliafis/RdRpCATCH
@@ -109,16 +109,18 @@ Activate the environment and download the RdRpCATCH databases:
109
109
 
110
110
  ```bash
111
111
  conda activate rdrpcatch
112
- rdrpcatch databases --destination_dir path/to/store/databases
112
+ rdrpcatch databases --destination-dir path/to/store/databases
113
113
  ```
114
114
 
115
115
  * Note 1: The databases are large files and may take some time to download (~ 3 GB).
116
116
  * Note 2: The databases are stored in the specified directory, and the path is required to run RdRpCATCH.
117
117
  * Note 3: If you encounter an SSL error while downloading, please try again. The error seems to appear sporadically during testing, and a simple re-initiation of the downloading process seems to fix it.
118
-
119
-
120
-
121
-
118
+ * Note 4: If the SSL error persists, or there is any other error related to downloading the databases, please let us know by raising an issue. In this case, you can download the pre-compiled databases manually via the zenodo repository
119
+ [10.5281/zenodo.15463729](https://doi.org/10.5281/zenodo.15463729) Save the repository to a local directory of your preferance, and then use the following command:
120
+ ```bash
121
+ tar -xvf rdrpcatch_dbs.tar
122
+ ```
123
+
122
124
  ## Usage
123
125
  RdRpCATCH can be used as a CLI tool as follows:
124
126
 
@@ -133,7 +135,7 @@ rdrpcatch scan -i path/to/input.fasta -o path/to/output_dir -db-dir path/to/data
133
135
  ## Input description
134
136
  The input file can be one or more nucleotide or protein sequences in multi-fasta format.
135
137
  The output directory is where the results will be stored. We recommend specifying the type of the sequence in the command line,
136
- An optional argument `--seq_type` (nuc or prot) can be used to specify if the input fasta file sequences are nucleotide or amino acid.
138
+ An optional argument `--seq-type` (nuc or prot) can be used to specify if the input fasta file sequences are nucleotide or amino acid.
137
139
 
138
140
 
139
141
  ## Setting up custom pHMM databases
@@ -154,7 +156,7 @@ rdrpcatch databases --add-custom-db path/to/my_custom_rdrp_database --destinatio
154
156
  - The custom database can then be used with the `rdrpcatch scan` command by specifying the `--custom-dbs` argument as follows:
155
157
  -
156
158
  ```bash
157
- rdrpcatch scan -i path/to/input.fasta -o path/to/output_dir -db_dir path/to/database --custom-dbs custom_database_name
159
+ rdrpcatch scan -i path/to/input.fasta -o path/to/output_dir -db-dir path/to/database --custom-dbs custom_database_name
158
160
  ```
159
161
 
160
162
  - The `custom_database_name` should be the name of the directory that contains the custom pHMM files, without the path.
@@ -164,7 +166,7 @@ rdrpcatch scan -i path/to/input.fasta -o path/to/output_dir -db_dir path/to/data
164
166
  - For example, if you want to use the NeoRdRp and RVMT databases along with your custom database, you would use the following command:
165
167
 
166
168
  ```bash
167
- rdrpcatch scan -i path/to/input.fasta -o path/to/output_dir -db_dir path/to/database --db_options NeoRdRp,RVMT --custom-dbs my_custom_rdrp_database
169
+ rdrpcatch scan -i path/to/input.fasta -o path/to/output_dir -db-dir path/to/database --db-options NeoRdRp,RVMT --custom-dbs my_custom_rdrp_database
168
170
  ```
169
171
 
170
172
  - Note: By default, RdRpCATCH will search against all pre-compiled databases if no `--db_options` argument is specified. If you want to use only the custom databases, you can specify `--db_options none` to avoid searching against the pre-compiled databases.
@@ -1,7 +1,7 @@
1
1
  rdrpcatch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
- rdrpcatch/rdrpcatch_wrapper.py,sha256=sV2xvkRcyJvxjk3ybN0FaaSn7uDsbJ2FbQreaEG2hgo,33674
2
+ rdrpcatch/rdrpcatch_wrapper.py,sha256=BBBJLYfPGfwmVPqBKY9Zp7PEM0lOZ82sXhOjAlILqlU,33682
3
3
  rdrpcatch/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
- rdrpcatch/cli/args.py,sha256=e3gAu84rMbEkQeijyy2m2wWBiymvbPRzkrzsdWdTOfk,15389
4
+ rdrpcatch/cli/args.py,sha256=B-elG1FHVHNXUCDDcVIqfv4oajhVi2Jbyk7T4r7j38U,15389
5
5
  rdrpcatch/rdrpcatch_scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
6
6
  rdrpcatch/rdrpcatch_scripts/fetch_dbs.py,sha256=BuiTlwe8d489zP0TIsfd-KuynccQRSae_k5dPAXKyk4,11368
7
7
  rdrpcatch/rdrpcatch_scripts/format_pyhmmer_out.py,sha256=2_ERXFQK2lpVReWl0jwQdnKIObv_zq07uFJOzGsTHlo,25025
@@ -12,8 +12,8 @@ rdrpcatch/rdrpcatch_scripts/plot.py,sha256=Y1mZL7rkKHFKEs2D7T2Qj2kpfiORmFwRLq1LY
12
12
  rdrpcatch/rdrpcatch_scripts/run_pyhmmer.py,sha256=9zcMzaIwQ4_-NgYzG9kejxOBaDi-gbzaqpvZti8ZXA4,9008
13
13
  rdrpcatch/rdrpcatch_scripts/run_seqkit.py,sha256=5y7DtJ6NLa4sRoBQOcjBfczKlqG_LibNrEqNmKLrHu0,4361
14
14
  rdrpcatch/rdrpcatch_scripts/utils.py,sha256=jvpyPxchAMn6BeLV7HOFECSY_a3nbkxDBBL8tunmM8A,16938
15
- rdrpcatch-0.0.8.dist-info/METADATA,sha256=JpFlynLSxi9M-JeH5Gr2Y4lFEITwtsfrWvcyY-F-TjA,20768
16
- rdrpcatch-0.0.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
17
- rdrpcatch-0.0.8.dist-info/entry_points.txt,sha256=uiyoPO41jNz_KVOt2JdPak9NbVei-D8WQ6saMeMBFpE,53
18
- rdrpcatch-0.0.8.dist-info/licenses/LICENSE,sha256=3jm5vKRMIaiETEFfNN34-oyWUShxZtmDmL38PNAwlUI,1120
19
- rdrpcatch-0.0.8.dist-info/RECORD,,
15
+ rdrpcatch-0.0.9.dist-info/METADATA,sha256=qKlIOLtvK1WytBHIAoMx_PKtZ-9weUkqJGCAiX0Dy-Q,21209
16
+ rdrpcatch-0.0.9.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
17
+ rdrpcatch-0.0.9.dist-info/entry_points.txt,sha256=uiyoPO41jNz_KVOt2JdPak9NbVei-D8WQ6saMeMBFpE,53
18
+ rdrpcatch-0.0.9.dist-info/licenses/LICENSE,sha256=3jm5vKRMIaiETEFfNN34-oyWUShxZtmDmL38PNAwlUI,1120
19
+ rdrpcatch-0.0.9.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: hatchling 1.27.0
2
+ Generator: hatchling 1.28.0
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any