snaketest


Namesnaketest JSON
Version 0.0.4 PyPI version JSON
download
home_pagehttps://github.com/aLahat/snaketest
SummaryA small package to help test and prototype snakemake rules
upload_time2022-12-20 17:40:01
maintainer
docs_urlNone
authorAlbert
requires_python
licenseMIT License
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# snaketest

## instalation:
` pip install snaketest`
## runing

A small package to help test and prototype snakemake rules
```python
from  snaketest import *
```
The idea is to make the prototype as copypasteable as possible
Rou declare input and output by just initializing a snaketest class.
You can just copy paste the content of the input, output, log, params... 
```python
input = snaketest(
    table='data/table.csv',
    genome='data/genome.fa',
    sample = expand('data/sample/{sample}.csv',sample=[1,2,3]) #there's even an expand function
)
```
You can even use wildcards in them
```python
output = snaketest(
    csv='results/table_{chromosome}.csv',
)
```
But if you do you gotta create a wildcard SM which the other SM classes will refer to
```python
wildcards = snaketest(
  chromosome="chrY"
)
```
Now you can fill the code using SM variables:
```python
import pandas as pd
df = pd.read_csv(input.table)
df = df[df['chromosome']==wildcards.chromosome]
```
Because all variables are in the snakemake format, you can just test and copy paste withought needing to manually change anything.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/aLahat/snaketest",
    "name": "snaketest",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Albert",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/78/70/ea122e2125b6352ae4c51c4ae2ea16bd07113aec3f602094b5b29cadf987/snaketest-0.0.4.tar.gz",
    "platform": null,
    "description": "\r\n# snaketest\r\n\r\n## instalation:\r\n` pip install snaketest`\r\n## runing\r\n\r\nA small package to help test and prototype snakemake rules\r\n```python\r\nfrom  snaketest import *\r\n```\r\nThe idea is to make the prototype as copypasteable as possible\r\nRou declare input and output by just initializing a snaketest class.\r\nYou can just copy paste the content of the input, output, log, params... \r\n```python\r\ninput = snaketest(\r\n    table='data/table.csv',\r\n    genome='data/genome.fa',\r\n    sample = expand('data/sample/{sample}.csv',sample=[1,2,3]) #there's even an expand function\r\n)\r\n```\r\nYou can even use wildcards in them\r\n```python\r\noutput = snaketest(\r\n    csv='results/table_{chromosome}.csv',\r\n)\r\n```\r\nBut if you do you gotta create a wildcard SM which the other SM classes will refer to\r\n```python\r\nwildcards = snaketest(\r\n  chromosome=\"chrY\"\r\n)\r\n```\r\nNow you can fill the code using SM variables:\r\n```python\r\nimport pandas as pd\r\ndf = pd.read_csv(input.table)\r\ndf = df[df['chromosome']==wildcards.chromosome]\r\n```\r\nBecause all variables are in the snakemake format, you can just test and copy paste withought needing to manually change anything.\r\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "A small package to help test and prototype snakemake rules",
    "version": "0.0.4",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b7f09ad698c1d84eccd678f598500366",
                "sha256": "94f386c27412f3d31a840452b88030353c1611e3301f2dc4964e5ccbb1ec880c"
            },
            "downloads": -1,
            "filename": "snaketest-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b7f09ad698c1d84eccd678f598500366",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3225,
            "upload_time": "2022-12-20T17:39:59",
            "upload_time_iso_8601": "2022-12-20T17:39:59.568623Z",
            "url": "https://files.pythonhosted.org/packages/ec/55/e771a025ce5b62a335c8b7380a239c08bc77bc3cd74d969054f6a6869ddf/snaketest-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "c1591839469738c6f594563ed3932bcf",
                "sha256": "629b13f4c82c1da89856d5672096566e5e9c2b78b3b333723057a3707e6086c7"
            },
            "downloads": -1,
            "filename": "snaketest-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "c1591839469738c6f594563ed3932bcf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2946,
            "upload_time": "2022-12-20T17:40:01",
            "upload_time_iso_8601": "2022-12-20T17:40:01.388195Z",
            "url": "https://files.pythonhosted.org/packages/78/70/ea122e2125b6352ae4c51c4ae2ea16bd07113aec3f602094b5b29cadf987/snaketest-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-20 17:40:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "aLahat",
    "github_project": "snaketest",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "snaketest"
}
        
Elapsed time: 0.11692s