mudatasets

Name	mudatasets JSON
Version	0.0.2 JSON
	download
home_page	https://github.com/PMBio/mudatasets
Summary	Multimodal Datasets in MuData format
upload_time	2022-12-11 18:19:15
maintainer
docs_url	None
author	Danila Bredikhin
requires_python	>= 3.7
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Multimodal Datasets

`mudatasets` provides some public datasets with multimodal data, primarily focusing on multimodal omics datasets.

[MuData library](https://github.com/PMBio/mudata) | [MuData documentation](https://mudata.readthedocs.io/)

## Installation

[![PyPi version](https://img.shields.io/pypi/v/mudatasets)](https://pypi.org/project/mudatasets)

```
# Stable, with muon
pip install "mudatasets[muon]"
# Dev
pip install git+https://github.com/gtca/mudatasets
```

## Getting started

```py
import mudatasets as mds
```

### Find available datasets

```py
mds.list_datasets()
```

### Load a dataset

```py
mdata = mds.load("pbmc3k_multiome")
print(mdata)
```

Some common attributes for `.load()` are:

- `data_dir=` for location to save the dataset (`~/mudatasets/` by default)
- `with_info=True` for also returning the second argument with dataset description as a dictionary (`False` by default)
- `backed=True` for reading data in a backed format, only for `.h5mu` and `.h5ad` files (`True` by default)
- `files=` for downloading specific files from the dataset
- `full=True` for downloading all the files defined for the dataset (`False` by default)

### Get dataset info

```py
mds.info("pbmc3k_multiome")
```

### List dataset file names

```py
mds.list_files("pbmc3k_multiome")
```

### Webpage with all the files

```py
mds.serve_webpage(port=8000)
```

This command will launch a server providing a simple (temporarily created) HTML page at http://localhost:8000 with files across all of the datasets listed.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/PMBio/mudatasets",
    "name": "mudatasets",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">= 3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Danila Bredikhin",
    "author_email": "danila.bredikhin@embl.de",
    "download_url": "https://files.pythonhosted.org/packages/19/ec/ab90ad6f592e67c8c2845bd66681c38279063820f5ad13cfd363927fc79e/mudatasets-0.0.2.tar.gz",
    "platform": null,
    "description": "# Multimodal Datasets\n\n`mudatasets` provides some public datasets with multimodal data, primarily focusing on multimodal omics datasets.\n\n[MuData library](https://github.com/PMBio/mudata) | [MuData documentation](https://mudata.readthedocs.io/)\n\n## Installation\n\n[![PyPi version](https://img.shields.io/pypi/v/mudatasets)](https://pypi.org/project/mudatasets)\n\n```\n# Stable, with muon\npip install \"mudatasets[muon]\"\n# Dev\npip install git+https://github.com/gtca/mudatasets\n```\n\n## Getting started\n\n```py\nimport mudatasets as mds\n```\n\n### Find available datasets\n\n```py\nmds.list_datasets()\n```\n\n### Load a dataset\n\n```py\nmdata = mds.load(\"pbmc3k_multiome\")\nprint(mdata)\n```\n\nSome common attributes for `.load()` are:\n\n- `data_dir=` for location to save the dataset (`~/mudatasets/` by default)\n- `with_info=True` for also returning the second argument with dataset description as a dictionary (`False` by default)\n- `backed=True` for reading data in a backed format, only for `.h5mu` and `.h5ad` files (`True` by default)\n- `files=` for downloading specific files from the dataset\n- `full=True` for downloading all the files defined for the dataset (`False` by default)\n\n### Get dataset info\n\n```py\nmds.info(\"pbmc3k_multiome\")\n```\n\n### List dataset file names\n\n```py\nmds.list_files(\"pbmc3k_multiome\")\n```\n\n### Webpage with all the files\n\n```py\nmds.serve_webpage(port=8000)\n```\n\nThis command will launch a server providing a simple (temporarily created) HTML page at http://localhost:8000 with files across all of the datasets listed.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Multimodal Datasets in MuData format",
    "version": "0.0.2",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "59ad1791b30a28aca277142a2183c829",
                "sha256": "a119b5dfefd783915eb5eb626e7bdebeba19db030bb801075307afd83165c9fe"
            },
            "downloads": -1,
            "filename": "mudatasets-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "59ad1791b30a28aca277142a2183c829",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">= 3.7",
            "size": 12433,
            "upload_time": "2022-12-11T18:19:13",
            "upload_time_iso_8601": "2022-12-11T18:19:13.092467Z",
            "url": "https://files.pythonhosted.org/packages/ea/70/f65a1a4c3fe16b7a8de70f5d5514cd3c550aea103a291da8221f02865d6f/mudatasets-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "432e2e278a40babdc04dd4e0a44e1cc3",
                "sha256": "a7b703059201756e2abd4c83d6ccd3b37fa18e2f4e1760959c71195dcaae28de"
            },
            "downloads": -1,
            "filename": "mudatasets-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "432e2e278a40babdc04dd4e0a44e1cc3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">= 3.7",
            "size": 9470,
            "upload_time": "2022-12-11T18:19:15",
            "upload_time_iso_8601": "2022-12-11T18:19:15.355430Z",
            "url": "https://files.pythonhosted.org/packages/19/ec/ab90ad6f592e67c8c2845bd66681c38279063820f5ad13cfd363927fc79e/mudatasets-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-11 18:19:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "PMBio",
    "github_project": "mudatasets",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mudatasets"
}