added fn desc

BIONF · Feb 2, 2023 · bfbc324 · bfbc324
1 parent ad8741d
commit bfbc324
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/fdog/libs/addtaxon.py b/fdog/libs/addtaxon.py
@@ -54,6 +54,7 @@ def create_folders(outPath, spec_name, coreTaxa, noAnno):
 
 
 def generate_spec_name(tax_id, name, ver):
+    """ Create species name with the format <ABBR_NAME>@<NCBI_TAXID>@<VER> """
     if name == "":
         ncbi_name = tree_fn.check_tax_id(tax_id)
         name = tree_fn.abbr_ncbi_name(ncbi_name)

diff --git a/fdog/libs/alignment.py b/fdog/libs/alignment.py
@@ -31,6 +31,7 @@
 ##### FUNCTIONS RELATED TO SEQ ALIGNMENT #####
 
 def check_fasta36_executable(fdogPath):
+    """ Check if FASTA36 installed in fdogPath """
     try:
         fasta36_cmd = '%s/bin/aligner/bin/ggsearch36' % fdogPath
         subprocess.check_output(fasta36_cmd, shell = True, stderr = subprocess.STDOUT)

diff --git a/fdog/libs/blast.py b/fdog/libs/blast.py
@@ -72,6 +72,7 @@ def parse_blast_xml(blast_output):
 
 
 def make_blastdb(args):
+    """ Make blastDB in coreTaxa_dir (for fdog.addTaxon and fdog.addTaxa) """
     (specName, specFile, outPath, silent) = args
     blastCmd = 'makeblastdb -dbtype prot -in %s -out %s/coreTaxa_dir/%s/%s' % (specFile, outPath, specName, specName)
     if silent == True: