Merge pull request #144 from pepkit/dev

Release 0.12.8

Author: donaldcampbelljr

.github/workflows/black.yml

@@ -6,6 +6,6 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
       - uses: psf/black@stable

.github/workflows/python-publish.yml

@@ -24,4 +24,4 @@ jobs:
       run: |
         python setup.py sdist bdist_wheel
     - name: Publish package distributions to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      uses: pypa/gh-action-pypi-publish@release/v1

MANIFEST.in

@@ -1,6 +1,9 @@
 include requirements/*
 include README.md
 include docs/img/geofetch_logo.svg
-include geofetch/config_template.yaml
-include geofetch/config_processed_template.yaml
-include geofetch/looper_sra_convert.yaml
+include geofetch/templates/*
+include geofetch/templates/config_template.yaml
+include geofetch/templates/config_processed_template.yaml
+include geofetch/templates/looper_sra_convert.yaml
+include geofetch/templates/looper_config_template.yaml
+include geofetch/templates/pipeline_interface_convert.yaml

README.md

@@ -44,6 +44,12 @@ or install the latest version from the GitHub repository:
 pip install git+https://github.com/pepkit/geofetch.git
 ```
 
+## All GEO projects (GSE + GSM) in PEP format.
+
+All GEO projects are available in PEPhub under geo namespace: https://pephub.databio.org/geo/ .
+User can search for GEO projects using the search bar, or download archive with all GEO PEPs from archive section of the namespace:
+[https://pephub.databio.org/geo?view=archive](https://pephub.databio.org/geo?view=archive)
+
 
 ## How to cite:
 https://doi.org/10.1093/bioinformatics/btad069

geofetch/__init__.py

@@ -1,4 +1,4 @@
-""" Package-level data """
+"""Package-level data"""
 
 import coloredlogs
 import logmuse

geofetch/_version.py

@@ -1 +1 @@
-__version__ = "0.12.7"
+__version__ = "0.12.8"

geofetch/cli.py

@@ -2,6 +2,7 @@
 import os
 
 import logmuse
+from ubiquerg import VersionInHelpParser
 
 from geofetch._version import __version__
 
@@ -15,7 +16,7 @@ def _parse_cmdl(cmdl):
     """
     parser
     """
-    parser = argparse.ArgumentParser(
+    parser = VersionInHelpParser(
         description="Automatic GEO and SRA data downloader",
         usage="""geofetch [<args>]
 
@@ -26,15 +27,12 @@ def _parse_cmdl(cmdl):
     geofetch -i GSE67303 --processed --geo-folder <folder> -m <folder>
 
 """,
+        version=__version__,
     )
 
     processed_group = parser.add_argument_group("processed")
     raw_group = parser.add_argument_group("raw")
 
-    parser.add_argument(
-        "-V", "--version", action="version", version=f"%(prog)s {__version__}"
-    )
-
     # Required
     parser.add_argument(
         "-i",

geofetch/const.py

@@ -44,9 +44,14 @@
 
 NEW_GENOME_COL_NAME = "ref_genome"
 
+TEMPLATES_DIR = "templates"
 CONFIG_PROCESSED_TEMPLATE_NAME = "config_processed_template.yaml"
 CONFIG_RAW_TEMPLATE_NAME = "config_template.yaml"
-CONFIG_SRA_TEMPLATE = "looper_sra_convert.yaml"
+CONFIG_SRA_TEMPLATE_NAME = "looper_sra_convert.yaml"
+PIPELINE_INTERFACE_CONVERT_TEMPLATE_NAME = "pipeline_interface_convert.yaml"
+LOOPER_SRA_CONVERT = "looper_config_template.yaml"
+# SRA_CONVERT_SCHEMA_NAME = "sra_convert_schema.yaml"
+# RESOURCES_NAME = "resources.tsv"
 
 # const for Finder:
 RETMAX = 10000000  # once it should be increased
@@ -63,3 +68,5 @@
     '+AND+("{start_date}"[Publication%20Date]%20:%20"{end_date}"[Publication%20Date])'
 )
 THREE_MONTH_FILTER = '+AND+"published+last+3+months"[Filter]'
+
+LOOPER_CONFIG_FILE_NAME = "looper_config.yaml"

geofetch/geofetch.py

@@ -20,7 +20,7 @@
 from geofetch.const import (
     CONFIG_PROCESSED_TEMPLATE_NAME,
     CONFIG_RAW_TEMPLATE_NAME,
-    CONFIG_SRA_TEMPLATE,
+    CONFIG_SRA_TEMPLATE_NAME,
     EXP_SUPP_METADATA_FILE,
     EXPERIMENT_PATTERN,
     FILE_RAW_NAME_SAMPLE_PATTERN,
@@ -34,6 +34,10 @@
     SAMPLE_SUPP_METADATA_FILE,
     SER_SUPP_FILE_PATTERN,
     SUPP_FILE_PATTERN,
+    TEMPLATES_DIR,
+    PIPELINE_INTERFACE_CONVERT_TEMPLATE_NAME,
+    LOOPER_SRA_CONVERT,
+    LOOPER_CONFIG_FILE_NAME,
 )
 from geofetch.utils import (
     Accession,
@@ -867,6 +871,8 @@ def _expand_metadata_list(self, metadata_list: list) -> list:
         _LOGGER.info("Expanding metadata list...")
         list_of_keys = _get_list_of_keys(metadata_list)
         for key_in_list in list_of_keys:
+            if key_in_list == "Sample_characteristics_ch1":
+                pass
             metadata_list = self._expand_metadata_list_item(metadata_list, key_in_list)
         return metadata_list
 
@@ -881,7 +887,13 @@ def _expand_metadata_list_item(self, metadata_list: list, dict_key: str):
         """
         try:
             element_is_list = any(
-                isinstance(list_item.get(dict_key), list) for list_item in metadata_list
+                isinstance(list_item.get(dict_key), list)
+                or (
+                    len(list_item.get(dict_key).split(": ")) == 2
+                    if list_item.get(dict_key)
+                    else False
+                )
+                for list_item in metadata_list
             )
 
             # # checking if some items have two keys:
@@ -900,6 +912,8 @@ def _expand_metadata_list_item(self, metadata_list: list, dict_key: str):
                             metadata_list[n_elem][dict_key] = [
                                 metadata_list[n_elem][dict_key]
                             ]
+                        else:
+                            pass
 
                         just_string = False
                         this_string = ""
@@ -1087,7 +1101,7 @@ def _find_genome(metadata_list: list) -> list:
             sample_genome = ""
             for key in proj_gen_keys:
                 sample_genome = " ".join([sample_genome, sample[1][key]])
-            metadata_list[sample[0]][NEW_GENOME_COL_NAME] = sample_genome
+            metadata_list[sample[0]][NEW_GENOME_COL_NAME] = sample_genome.strip()
         return metadata_list
 
     def _write_raw_annotation_new(
@@ -1161,11 +1175,43 @@ def _write_raw_annotation_new(
             if len(subannot_dict) > 0:
                 self._write_subannotation(subannot_dict, proj_root_subsample)
 
-            self._write(proj_root_yaml, template, msg_pre="  Config file: ")
+            self._write(proj_root_yaml, template, msg_pre="Config file: ")
 
             if self.add_dotfile:
                 _create_dot_yaml(dot_yaml_path, yaml_name)
 
+            if self.add_convert_modifier:
+                geofetchdir = os.path.dirname(__file__)
+                pipeline_interface_convert_path = os.path.join(
+                    geofetchdir, TEMPLATES_DIR, PIPELINE_INTERFACE_CONVERT_TEMPLATE_NAME
+                )
+
+                looper_config_template_path = os.path.join(
+                    geofetchdir, TEMPLATES_DIR, LOOPER_SRA_CONVERT
+                )
+
+                with open(looper_config_template_path, "r") as template_file:
+                    template_looper = template_file.read()
+
+                template_values = {
+                    "pep_config": proj_root_yaml,
+                    "output_dir": os.path.join(self.metadata_root_full, "output_dir"),
+                    "pipeline_interface_convert": pipeline_interface_convert_path,
+                }
+
+                for k, v in template_values.items():
+                    placeholder = "{" + str(k) + "}"
+                    template_looper = template_looper.replace(placeholder, str(v))
+
+                looper_config_file = os.path.join(
+                    self.metadata_root_full,
+                    LOOPER_CONFIG_FILE_NAME,
+                )
+
+                self._write(
+                    looper_config_file, template_looper, msg_pre="Looper config file: "
+                )
+
         else:
             meta_df = pd.DataFrame.from_dict(metadata_dict, orient="index")
 
@@ -1204,8 +1250,11 @@ def _create_config_processed(
         :param meta_in_series:
         :return: generated, complete config file content
         """
+
         geofetchdir = os.path.dirname(__file__)
-        config_template = os.path.join(geofetchdir, CONFIG_PROCESSED_TEMPLATE_NAME)
+        config_template = os.path.join(
+            geofetchdir, TEMPLATES_DIR, CONFIG_PROCESSED_TEMPLATE_NAME
+        )
         with open(config_template, "r") as template_file:
             template = template_file.read()
         meta_list_str = [
@@ -1260,9 +1309,13 @@ def _create_config_raw(
         else:
             sample_modifier_str = ""
         if not self.config_template:
-            self.config_template = os.path.join(geofetchdir, CONFIG_RAW_TEMPLATE_NAME)
+            self.config_template = os.path.join(
+                geofetchdir, TEMPLATES_DIR, CONFIG_RAW_TEMPLATE_NAME
+            )
         if self.add_convert_modifier:
-            sra_convert_path = os.path.join(geofetchdir, CONFIG_SRA_TEMPLATE)
+            sra_convert_path = os.path.join(
+                geofetchdir, TEMPLATES_DIR, CONFIG_SRA_TEMPLATE_NAME
+            )
             with open(sra_convert_path, "r") as template_file:
                 sra_convert_template = template_file.read()
         else:
@@ -1291,6 +1344,7 @@ def _create_config_raw(
         for k, v in template_values.items():
             placeholder = "{" + str(k) + "}"
             template = template.replace(placeholder, str(v))
+
         return template
 
     @staticmethod

geofetch/sraconvert.py

@@ -2,7 +2,7 @@
 
 import os
 import sys
-from argparse import ArgumentParser
+from ubiquerg import VersionInHelpParser
 
 import logmuse
 import pypiper
@@ -15,7 +15,7 @@ def _parse_cmdl(cmdl):
     provides convenience functions for converting or deleting sra data in
     various formats.
     """
-    parser = ArgumentParser(description=description)
+    parser = VersionInHelpParser(description=description)
     # parser = pypiper.add_pypiper_args(parser, args=["output-parent"])
     parser.add_argument(
         "-m",
@@ -72,6 +72,9 @@ def _parse_cmdl(cmdl):
         help="Name for sample to run",
         metavar="SAMPLE_NAME",
     )
+    parser.add_argument(
+        "-V", "--version", action="version", version=f"%(prog)s {__version__}"
+    )
 
     parser.add_argument("-r", "--srr", required=True, nargs="+", help="SRR files")