hydra-genetics


Namehydra-genetics JSON
Version 3.1.1 PyPI version JSON
download
home_pagehttps://github.com/hydra-genetics/tools
SummaryHelper tools for use with hydra-genetics pipelines.
upload_time2024-11-06 07:35:56
maintainerNone
docs_urlNone
authorPatrik Smeds
requires_pythonNone
licenseGPL-3
keywords hydra-genetics snakemake bioinformatics workflow pipeline clinical biology sequencing ngs next generation sequencing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
<a href="https://hydra-genetics.readthedocs.io">https://hydra-genetics.readthedocs.io</a>
</p>

# <img src="images/hydragenetics.png" width=40 /> Hydra-genetics

Command line interface to create new modules/pipelines or adding a new rule to an existing project. Provides libraries used to make it easier for people not used to pandas to extract information from samples and units dataframes. These dataframes are generated from [units.tsv](https://github.com/hydra-genetics/tools/blob/develop/hydra_genetics/pipeline-template/workflow/schemas/units.schema.yaml) and [samples.tsv](https://github.com/hydra-genetics/prealignment/blob/develop/workflow/schemas/samples.schema.yaml) files which are used as input.

[![Lint and Test](https://github.com/hydra-genetics/tools/actions/workflows/main.yaml/badge.svg?branch=develop)](https://github.com/hydra-genetics/tools/actions/workflows/main.yaml)

[![build mkdocs](https://github.com/hydra-genetics/hydra-genetics/actions/workflows/test-build-mkdocs.yaml/badge.svg)](https://github.com/hydra-genetics/hydra-genetics/actions/workflows/test-build-mkdocs.yaml)

![python](https://img.shields.io/badge/python-3.8-blue)

## Functions

* create
* reference


Example of how to generate a new project
```
 virtualenv -p python3.9 venv
 source venv/bin/activate
 pip install hydra-genetics
 hydra-genetics create-module -n snv -d "Collection of callers" -a "Patrik S" -e "p.s@mail.se" -g patrik -o snv
 # Create new smk file named "samtools.smk" with rule "samtools_rule2"
 hydra-genetics create-rule -c rule2 -t samtools -m snv -a test2 -e "test@test"
 # Add command to "samtools smk" file, rule name will be "samtools_rule3"
 hydra-genetics create-rule -c rule3 -t samtools -m snv -a test2 -e "test@test"

 # -t/--tool can be skipped for a single command tool, ex a script
 # this will create a smk file named "super_script.smk" with a rule "super_script"
 hydra-genetics create-rule -c rule3 -t samtools -m snv -a test2 -e "test@test"

 # Create input files
 hydra-genetics create-input-files -d path/dir1 -d path/dir2

 # Create singularity cache
 # all container specified in config.yaml will be fetched
 hydra-genetics singularity create-singularity-files  -o singularity_cache -c config.yaml

```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hydra-genetics/tools",
    "name": "hydra-genetics",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "hydra-genetics, snakemake, bioinformatics, workflow, pipeline, clinical, biology, sequencing, NGS, next generation sequencing",
    "author": "Patrik Smeds",
    "author_email": "patrik.smeds@scilifelab.uu.se",
    "download_url": "https://files.pythonhosted.org/packages/bb/c3/9f87480182894fdf0853334e39c946adc21d8bc5edb849546cdf70e79681/hydra_genetics-3.1.1.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n<a href=\"https://hydra-genetics.readthedocs.io\">https://hydra-genetics.readthedocs.io</a>\n</p>\n\n# <img src=\"images/hydragenetics.png\" width=40 /> Hydra-genetics\n\nCommand line interface to create new modules/pipelines or adding a new rule to an existing project. Provides libraries used to make it easier for people not used to pandas to extract information from samples and units dataframes. These dataframes are generated from [units.tsv](https://github.com/hydra-genetics/tools/blob/develop/hydra_genetics/pipeline-template/workflow/schemas/units.schema.yaml) and [samples.tsv](https://github.com/hydra-genetics/prealignment/blob/develop/workflow/schemas/samples.schema.yaml) files which are used as input.\n\n[![Lint and Test](https://github.com/hydra-genetics/tools/actions/workflows/main.yaml/badge.svg?branch=develop)](https://github.com/hydra-genetics/tools/actions/workflows/main.yaml)\n\n[![build mkdocs](https://github.com/hydra-genetics/hydra-genetics/actions/workflows/test-build-mkdocs.yaml/badge.svg)](https://github.com/hydra-genetics/hydra-genetics/actions/workflows/test-build-mkdocs.yaml)\n\n![python](https://img.shields.io/badge/python-3.8-blue)\n\n## Functions\n\n* create\n* reference\n\n\nExample of how to generate a new project\n```\n virtualenv -p python3.9 venv\n source venv/bin/activate\n pip install hydra-genetics\n hydra-genetics create-module -n snv -d \"Collection of callers\" -a \"Patrik S\" -e \"p.s@mail.se\" -g patrik -o snv\n # Create new smk file named \"samtools.smk\" with rule \"samtools_rule2\"\n hydra-genetics create-rule -c rule2 -t samtools -m snv -a test2 -e \"test@test\"\n # Add command to \"samtools smk\" file, rule name will be \"samtools_rule3\"\n hydra-genetics create-rule -c rule3 -t samtools -m snv -a test2 -e \"test@test\"\n\n # -t/--tool can be skipped for a single command tool, ex a script\n # this will create a smk file named \"super_script.smk\" with a rule \"super_script\"\n hydra-genetics create-rule -c rule3 -t samtools -m snv -a test2 -e \"test@test\"\n\n # Create input files\n hydra-genetics create-input-files -d path/dir1 -d path/dir2\n\n # Create singularity cache\n # all container specified in config.yaml will be fetched\n hydra-genetics singularity create-singularity-files  -o singularity_cache -c config.yaml\n\n```\n",
    "bugtrack_url": null,
    "license": "GPL-3",
    "summary": "Helper tools for use with hydra-genetics pipelines.",
    "version": "3.1.1",
    "project_urls": {
        "Homepage": "https://github.com/hydra-genetics/tools"
    },
    "split_keywords": [
        "hydra-genetics",
        " snakemake",
        " bioinformatics",
        " workflow",
        " pipeline",
        " clinical",
        " biology",
        " sequencing",
        " ngs",
        " next generation sequencing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bbc39f87480182894fdf0853334e39c946adc21d8bc5edb849546cdf70e79681",
                "md5": "62d4b2adc8a0ba2161982da84ae936c6",
                "sha256": "2ca842dbe4f12c4e67ea9b17effc6812bd2dd485d18a7477b2d01b55011377c4"
            },
            "downloads": -1,
            "filename": "hydra_genetics-3.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "62d4b2adc8a0ba2161982da84ae936c6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 174730,
            "upload_time": "2024-11-06T07:35:56",
            "upload_time_iso_8601": "2024-11-06T07:35:56.457375Z",
            "url": "https://files.pythonhosted.org/packages/bb/c3/9f87480182894fdf0853334e39c946adc21d8bc5edb849546cdf70e79681/hydra_genetics-3.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-06 07:35:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hydra-genetics",
    "github_project": "tools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hydra-genetics"
}
        
Elapsed time: 0.42996s