diff --git a/.buildinfo b/.buildinfo index c053bd5..ebaf7ef 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9b8e571a50650677b7f4446e64b24ac5 +config: 5f1afb23639c06fcac335b3c17c33346 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_modules/biocframe/BiocFrame.html b/_modules/biocframe/BiocFrame.html index 5f8697d..de7cf3f 100644 --- a/_modules/biocframe/BiocFrame.html +++ b/_modules/biocframe/BiocFrame.html @@ -5,7 +5,7 @@ - biocframe.BiocFrame - BiocFrame 0.5.5 documentation + biocframe.BiocFrame - BiocFrame 0.5.6 documentation @@ -122,7 +122,7 @@
-
BiocFrame 0.5.5 documentation
+
BiocFrame 0.5.6 documentation
@@ -145,7 +145,7 @@
@@ -146,7 +146,7 @@ diff --git a/api/biocframe.io.html b/api/biocframe.io.html index 11290bd..60b7def 100644 --- a/api/biocframe.io.html +++ b/api/biocframe.io.html @@ -6,7 +6,7 @@ - biocframe.io package - BiocFrame 0.5.5 documentation + biocframe.io package - BiocFrame 0.5.6 documentation @@ -123,7 +123,7 @@
+
diff --git a/index.html b/index.html index 6cbed33..c94406f 100644 --- a/index.html +++ b/index.html @@ -6,7 +6,7 @@ - BiocFrame 0.5.5 documentation + BiocFrame 0.5.6 documentation @@ -123,7 +123,7 @@
@@ -144,7 +144,7 @@ -
+
diff --git a/readme.html b/readme.html index de17d91..9a3d661 100644 --- a/readme.html +++ b/readme.html @@ -6,7 +6,7 @@ - Bioconductor-like data frames - BiocFrame 0.5.5 documentation + Bioconductor-like data frames - BiocFrame 0.5.6 documentation @@ -123,7 +123,7 @@
@@ -146,7 +146,7 @@ diff --git a/search.html b/search.html index 613627e..a4ef9a4 100644 --- a/search.html +++ b/search.html @@ -4,7 +4,7 @@ - Search - BiocFrame 0.5.5 documentation + Search - BiocFrame 0.5.6 documentation @@ -120,7 +120,7 @@
diff --git a/searchindex.js b/searchindex.js index ed6e135..c58bc60 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["api/biocframe", "api/biocframe.io", "api/modules", "authors", "changelog", "contributing", "index", "license", "readme"], "filenames": ["api/biocframe.rst", "api/biocframe.io.rst", "api/modules.rst", "authors.md", "changelog.md", "contributing.md", "index.md", "license.md", "readme.md"], "titles": ["biocframe package", "biocframe.io package", "biocframe", "Contributors", "Changelog", "Contributing", "BiocFrame", "License", "Bioconductor-like data frames"], "terms": {"io": [0, 2, 8], "from_panda": [0, 2, 8], "class": [0, 4, 5, 8], "data": [0, 2, 6], "none": [0, 8], "number_of_row": 0, "row_nam": [0, 2, 8], "column_nam": [0, 2, 8], "column_data": [0, 2, 8], "metadata": [0, 2, 8], "valid": [0, 5], "true": [0, 5, 8], "sourc": [0, 1, 5], "base": [0, 4, 5, 8], "object": [0, 4, 6], "i": [0, 4, 5, 7, 8], "an": [0, 7, 8], "altern": [0, 8], "datafram": [0, 4, 8], "support": [0, 8], "nest": [0, 8], "flexibl": [0, 4], "column": [0, 2, 4, 8], "type": [0, 1, 4, 8], "inspir": 0, "dframe": [0, 8], "from": [0, 4, 5, 7, 8], "bioconductor": 0, "": [0, 4, 5, 8], "s4vector": [0, 8], "ani": [0, 5, 7], "mai": [0, 4, 5], "us": [0, 4, 5, 7, 8], "provid": [0, 1, 4, 5, 7, 8], "ha": [0, 4, 8], "some": [0, 4, 8], "concept": [0, 5, 8], "height": 0, "defin": 0, "get_height": 0, "biocutil": [0, 4, 8], "thi": [0, 4, 5, 7, 8], "default": [0, 4, 8], "length": [0, 8], "__len__": [0, 2, 8], "The": [0, 5, 7], "abil": 0, "slice": [0, 2, 4, 8], "integ": 0, "indic": [0, 8], "implement": [0, 4, 8], "subset": [0, 8], "call": [0, 8], "__getitem__": [0, 2, 4, 8], "combin": [0, 2, 4, 6], "other": [0, 5, 7], "perform": 0, "assign": [0, 8], "allow": [0, 4, 8], "accept": [0, 8], "arbitrarili": [0, 8], "complex": [0, 8], "instanc": [0, 8], "__array_ufunc__": [0, 2], "func": 0, "method": [0, 1, 4, 5, 8], "input": [0, 1], "kwarg": 0, "interfac": [0, 5], "numpi": 0, "arrai": 0, "note": 0, "veri": [0, 5], "primit": 0, "need": [0, 5], "test": [0, 4, 5], "differ": [0, 5, 8], "return": [0, 1, 5], "same": [0, 5, 8], "caller": 0, "__copy__": [0, 2, 4], "A": [0, 4, 7, 8], "shallow": [0, 8], "copi": [0, 2, 5, 7, 8], "current": [0, 5], "__deepcopy__": [0, 2], "memo": 0, "_nil": 0, "deep": 0, "__delitem__": [0, 2], "name": [0, 4, 5, 8], "alia": [0, 1], "remove_column": [0, 2], "in_plac": [0, 8], "As": [0, 4], "mutat": [0, 8], "origin": [0, 5, 8], "warn": 0, "rais": 0, "arg": 0, "wrapper": 0, "around": 0, "get_column": [0, 2, 8], "get_slic": [0, 2], "obtain": [0, 7], "its": [0, 5], "paramet": [0, 4], "union": 0, "int": 0, "str": 0, "sequenc": [0, 8], "tupl": 0, "scalar": 0, "string": 0, "specifi": [0, 8], "retain": 0, "1": [0, 5, 6, 8], "first": [0, 5], "entri": 0, "row": [0, 2, 4, 8], "2": [0, 5, 6, 8], "while": [0, 4, 5], "second": 0, "If": [0, 5, 8], "achiev": [0, 8], "intern": [0, 4, 5], "new": [0, 5, 8], "contain": 0, "onli": [0, 1, 8], "just": [0, 5, 8], "argument": [0, 4, 8], "__init__": [0, 2], "initi": [0, 4], "option": [0, 4, 5], "dict": 0, "dictionari": [0, 8], "kei": 0, "valu": 0, "all": [0, 4, 5, 7], "must": 0, "have": [0, 5, 8], "empti": 0, "number": [0, 8], "infer": 0, "ar": [0, 4, 5, 8], "present": 0, "list": [0, 5, 8], "should": [0, 5], "miss": [0, 5], "order": [0, 5], "than": 0, "about": [0, 5], "addit": [0, 4, 5], "bool": 0, "__iter__": [0, 2], "iter": 0, "over": 0, "biocframeit": [0, 2], "__repr__": [0, 2], "represent": [0, 8], "__setitem__": [0, 2], "set_column": [0, 2, 8], "set_slic": [0, 2], "modifi": [0, 5, 7, 8], "place": [0, 8], "assum": [0, 5, 8], "expect": [0, 4, 5], "pass": [0, 4, 5], "onto": 0, "replac": [0, 5, 8], "These": [0, 8], "properti": [0, 8], "colnam": [0, 2], "get_column_nam": [0, 2, 8], "back": [0, 1, 8], "compat": [0, 1, 5], "get_column_data": [0, 2, 4], "panda": [0, 4, 6], "relaxed_combine_row": [0, 2, 4, 8], "get_data": [0, 2], "dim": [0, 2], "shape": [0, 2, 8], "classmethod": 0, "creat": [0, 8], "which": [0, 5, 8], "exist": [0, 8], "index": [0, 2, 4, 5, 6], "interest": [0, 5], "with_nam": [0, 4], "whether": [0, 7], "set": [0, 4, 6], "annot": 0, "each": 0, "where": 0, "correspond": [0, 8], "get_metadata": [0, 2], "get_row": [0, 2, 8], "access": [0, 4, 8], "avail": [0, 5], "see": [0, 5, 8], "get_row_nam": [0, 2], "suppli": 0, "instead": [0, 4, 5, 8], "occurr": 0, "along": [0, 8], "extract": [0, 6], "boolean": [0, 8], "thereof": 0, "normalize_subscript": 0, "treat": 0, "has_column": [0, 2], "fals": [0, 4, 8], "remov": [0, 4, 5], "conveni": 0, "posit": [0, 4], "either": [0, 5, 8], "refer": [0, 4, 5, 6, 8], "rownam": [0, 2], "add": [0, 4, 5, 8], "set_column_data": [0, 2, 8], "numbero": 0, "equal": [0, 8], "set_column_nam": [0, 2, 8], "uniqu": 0, "set_metadata": [0, 2, 8], "set_row_nam": [0, 2, 8], "given": 0, "mixtur": 0, "so": [0, 7, 8], "ignor": [0, 4], "split": [0, 2], "only_indic": 0, "group": [0, 5], "repres": 0, "frame": 0, "map": 0, "to_panda": [0, 2, 8], "convert": [0, 4], "obj": [0, 8], "__next__": [0, 2], "merg": [0, 2, 4, 5, 7, 8], "x": [0, 8], "join": [0, 8], "left": 0, "rename_duplicate_column": 0, "multipl": [0, 4], "togeth": 0, "common": 0, "yield": 0, "across": [0, 8], "ident": [0, 8], "locat": 0, "liter": 0, "inner": 0, "right": [0, 7], "outer": [0, 8], "strategi": 0, "For": [0, 5, 8], "we": [0, 5, 8], "consid": [0, 5], "last": 0, "respect": [0, 5], "duplic": 0, "non": [0, 5], "automat": [0, 5], "renam": 0, "error": [0, 5], "store": 0, "0": [0, 5, 6, 8], "otherwis": [0, 7, 8], "thei": [0, 5, 8], "relaxed_combine_column": [0, 2], "relax": 0, "version": [0, 5, 6, 8], "combine_row": [0, 8], "wherea": 0, "absent": 0, "fill": 0, "appropri": 0, "placehold": 0, "befor": [0, 4, 5], "One": 0, "more": [0, 4, 5, 8], "possibli": 0, "consist": [0, 4], "mask": 0, "packag": [2, 4, 5, 6, 8], "subpackag": 2, "submodul": 2, "modul": [2, 5, 6], "content": [2, 5], "jayaram": [3, 8], "kancherla": [3, 8], "gmail": 3, "com": [3, 5, 8], "aaron": 3, "lun": 3, "infinit": 3, "monkei": 3, "keyboard": 3, "move": 4, "biocfram": [4, 5, 8], "attach": 4, "output": 4, "can": [4, 5, 8], "turn": 4, "off": 4, "bugfix": [4, 5], "avoid": [4, 5, 8], "effect": 4, "when": [4, 5], "function": [4, 5, 8], "style": [4, 5, 8], "onc": [4, 5], "reduc": 4, "varieti": 4, "simplifi": [4, 5], "user": [4, 5, 8], "refactor": 4, "gener": [4, 5, 8], "releas": 4, "migrat": 4, "palat": 4, "googl": 4, "python": [4, 5], "guid": [4, 5], "major": [4, 5], "modif": [4, 8], "case": [4, 5, 8], "camelcas": 4, "now": 4, "snake_cas": 4, "In": [4, 5], "docstr": [4, 5], "document": [4, 6, 7, 8], "been": [4, 5], "updat": [4, 5, 8], "sphinx": [4, 5], "featur": [4, 5], "link": [4, 5], "also": [4, 5, 8], "privat": [4, 5], "special": 4, "dunder": 4, "e": [4, 5, 8], "g": [4, 5, 8], "etc": 4, "intersphinx": 4, "depend": [4, 5], "configur": [4, 5], "flake8": [4, 5], "ruff": 4, "black": [4, 5], "ad": [4, 5], "pyproject": 4, "toml": 4, "setup": [4, 5], "cfg": [4, 5], "less": 4, "annoi": 4, "pyscaffold": [4, 5], "myst": [4, 5], "parser": 4, "markdown": 4, "compil": [4, 5], "recommonmark": 4, "part": [4, 5, 8], "one": [4, 5], "pre": [4, 5], "commit": [4, 5], "run": [4, 5], "routin": 4, "task": [4, 6], "lint": 4, "format": 4, "everi": 4, "sometim": [4, 5], "verifi": 4, "bring": 4, "code": [4, 6], "creation": 4, "github": [4, 5, 8], "action": [4, 7], "suppos": 5, "TO": [5, 7], "BE": [5, 7], "exampl": [5, 8], "IT": 5, "accord": 5, "you": [5, 8], "servic": 5, "promot": 5, "model": 5, "similar": 5, "fork": 5, "pull": 5, "request": 5, "workflow": 5, "like": 5, "gitlab": 5, "bitbucket": 5, "might": [5, 8], "gerrit": 5, "notic": [5, 7], "url": [5, 8], "text": 5, "specif": 5, "terminologi": 5, "pleas": [5, 8], "make": [5, 8], "sure": 5, "check": [5, 8], "assumpt": [5, 8], "mind": 5, "thing": 5, "accordingli": [5, 8], "correct": 5, "bottom": 5, "want": [5, 8], "look": 5, "contributor": 5, "especi": 5, "project": [5, 8], "open": 5, "templat": 5, "few": 5, "extra": 5, "decid": 5, "includ": [5, 7], "mention": 5, "label": [5, 8], "tracker": 5, "autom": 5, "welcom": 5, "focus": 5, "get": [5, 8], "potenti": 5, "familiar": 5, "develop": 5, "process": 5, "kind": [5, 7], "appreci": 5, "git": 5, "never": 5, "collabor": 5, "previous": 5, "org": [5, 8], "resourc": 5, "excel": 5, "freecodecamp": 5, "consider": 5, "reason": 5, "doubt": 5, "softwar": [5, 7], "foundat": 5, "conduct": 5, "good": 5, "term": 5, "behavior": 5, "guidelin": 5, "experi": 5, "bug": 5, "don": 5, "t": 5, "anyth": 5, "feel": 5, "free": [5, 7], "fire": 5, "forget": 5, "close": 5, "search": [5, 6], "solut": 5, "wa": [5, 8], "alreadi": 5, "problem": 5, "solv": 5, "inform": 5, "program": [5, 8], "oper": [5, 8], "system": 5, "step": 5, "reproduc": 5, "try": 5, "reproduct": 5, "minim": 5, "still": 5, "illustr": 5, "face": 5, "By": [5, 8], "factor": 5, "help": [5, 6], "u": [5, 8], "identifi": 5, "root": 5, "caus": 5, "doc": 5, "them": 5, "readabl": 5, "coher": 5, "mistak": 5, "main": [5, 8], "mean": 5, "kept": 5, "done": 5, "wai": 5, "markup": 5, "languag": 5, "restructuredtext": 5, "commonmark": 5, "extens": 5, "host": 5, "follow": [5, 7], "tip": 5, "web": 5, "quick": 5, "propos": 5, "file": [5, 7], "mechan": 5, "tricki": 5, "normal": 5, "work": [5, 8], "perfectli": 5, "fine": 5, "quit": 5, "handi": 5, "out": [5, 7, 8], "navig": 5, "folder": 5, "find": 5, "would": 5, "click": 5, "littl": 5, "pencil": 5, "icon": 5, "top": 5, "editor": 5, "finish": 5, "edit": 5, "write": 5, "messag": 5, "form": 5, "page": [5, 6], "describ": 5, "made": 5, "what": 5, "motiv": 5, "behind": 5, "local": 5, "machin": 5, "tox": 5, "built": [5, 8], "server": [5, 8], "preview": 5, "browser": 5, "http": [5, 8], "localhost": 5, "8000": 5, "python3": 5, "m": 5, "directori": 5, "_build": 5, "html": 5, "explan": 5, "architectur": 5, "descript": 5, "design": 5, "principl": 5, "least": 5, "summari": 5, "easi": [5, 8], "start": [5, 8], "quickli": 5, "trivial": 5, "best": [5, 8], "discuss": 5, "subject": [5, 7], "often": [5, 8], "unnecessari": 5, "recommend": 5, "isol": 5, "virtual": 5, "instal": [5, 8], "easili": [5, 8], "via": [5, 8], "virtualenv": 5, "path": 5, "venv": 5, "bin": 5, "activ": 5, "miniconda": 5, "conda": [5, 8], "n": 5, "3": [5, 6, 8], "six": 5, "pytest": 5, "cov": 5, "account": 5, "do": [5, 7, 8], "button": 5, "under": 5, "disk": 5, "yourlogin": 5, "cd": 5, "pip": [5, 8], "setuptool": 5, "abl": 5, "import": [5, 8], "repl": 5, "item": 5, "come": 5, "lot": 5, "hook": 5, "being": [5, 8], "written": 5, "branch": [5, 8], "hold": 5, "checkout": 5, "b": [5, 8], "my": 5, "public": 5, "api": [5, 8], "yourself": 5, "author": [5, 6, 7, 8], "rst": 5, "re": 5, "record": 5, "fix": 5, "eventu": 5, "unit": 5, "moreov": 5, "highli": 5, "histori": 5, "log": 5, "graph": 5, "decor": 5, "pretti": 5, "onelin": 5, "abbrev": 5, "recur": 5, "commun": 5, "pattern": 5, "break": 5, "after": 5, "pipx": 5, "sever": 5, "av": 5, "everyth": 5, "push": 5, "remot": 5, "go": 5, "send": 5, "review": 5, "uncom": 5, "paragraph": 5, "detail": [5, 8], "pr": 5, "draft": 5, "mark": 5, "readi": 5, "feedback": 5, "continu": 5, "integr": 5, "ci": [5, 8], "requir": 5, "build": 5, "fetch": [5, 8], "tag": 5, "upstream": 5, "command": 5, "script": 5, "egg": 5, "complet": 5, "well": 5, "info": 5, "src": 5, "txt": 5, "recreat": 5, "r": [5, 8], "flag": 5, "reliabl": 5, "7": [5, 8], "OR": [5, 7], "troubl": 5, "weird": 5, "upon": 5, "dedic": 5, "binari": 5, "freshli": 5, "drop": 5, "interact": 5, "session": 5, "occur": 5, "pdb": 5, "k": 5, "OF": [5, 7], "THE": [5, 7], "fall": 5, "breakpoint": 5, "manual": 5, "section": 5, "pypi": [5, 8], "publicli": 5, "instruct": 5, "permiss": [5, 7], "success": 5, "v1": 5, "clean": 5, "up": 5, "dist": 5, "rm": 5, "rf": 5, "confus": 5, "old": 5, "dirti": 5, "hash": 5, "size": 5, "distribut": [5, 7], "too": 5, "big": 5, "500kb": 5, "unwant": 5, "clutter": 5, "accident": 5, "publish": [5, 7], "upload": 5, "correctli": 5, "definit": 5, "even": [5, 8], "though": 5, "focu": 5, "idea": 5, "collect": 5, "appli": 5, "sort": 5, "compani": 5, "proprietari": 5, "overview": 6, "construct": 6, "plai": 6, "nice": 6, "further": 6, "read": 6, "contribut": 6, "issu": 6, "report": 6, "improv": 6, "maintain": 6, "licens": 6, "changelog": 6, "5": [6, 8], "mit": 7, "copyright": 7, "c": [7, 8], "2022": 7, "genentech": 7, "inc": 7, "herebi": 7, "grant": 7, "charg": 7, "person": 7, "associ": 7, "deal": 7, "without": 7, "restrict": 7, "limit": 7, "sublicens": 7, "sell": 7, "permit": 7, "whom": 7, "furnish": 7, "condit": 7, "abov": [7, 8], "shall": 7, "substanti": 7, "portion": 7, "AS": 7, "warranti": 7, "express": 7, "impli": 7, "BUT": 7, "NOT": 7, "merchant": 7, "fit": 7, "FOR": 7, "particular": 7, "purpos": 7, "AND": 7, "noninfring": 7, "IN": 7, "NO": 7, "event": 7, "holder": 7, "liabl": 7, "claim": 7, "damag": 7, "liabil": 7, "contract": 7, "tort": 7, "aris": 7, "connect": 7, "WITH": 7, "badg": 8, "your": 8, "readm": 8, "statu": 8, "cirru": 8, "svg": 8, "readthedoc": 8, "latest": 8, "en": 8, "stabl": 8, "coveral": 8, "img": 8, "shield": 8, "v": 8, "forg": 8, "vn": 8, "anaconda": 8, "monthli": 8, "download": 8, "pepi": 8, "tech": 8, "month": 8, "twitter": 8, "social": 8, "friendli": 8, "advantag": 8, "long": 8, "insid": 8, "To": 8, "simpli": 8, "ensembl": 8, "ens00001": 8, "ens00002": 8, "ens00003": 8, "symbol": 8, "map1a": 8, "bin1": 8, "esr1": 8, "bframe": 8, "print": 8, "anoth": 8, "rang": 8, "chr": 8, "chr1": 8, "chr2": 8, "chr3": 8, "1000": 8, "1100": 8, "5000": 8, "end": 8, "4000": 8, "5500": 8, "bframe2": 8, "row1": 8, "row2": 8, "row3": 8, "directli": 8, "individu": 8, "And": 8, "vector": 8, "column1": 8, "short": 8, "hand": 8, "singl": 8, "encourag": 8, "inadvert": 8, "larger": 8, "structur": 8, "column2": 8, "unchang": 8, "new_col_nam": 8, "4": 8, "chang": 8, "foo": 8, "bar": 8, "alpha": 8, "bravo": 8, "charli": 8, "entir": 8, "column_sourc": 8, "hgnc": 8, "direct": 8, "silent": 8, "nonetheless": 8, "testfram": 8, "6": 8, "similarli": 8, "could": 8, "y": 8, "f": 8, "set_": 8, "It": 8, "anywher": 8, "els": 8, "safer": 8, "variou": 8, "bframe1": 8, "odd": 8, "9": 8, "8": 8, "11": 8, "33": 8, "55": 8, "77": 8, "99": 8, "22": 8, "44": 8, "66": 8, "88": 8, "10": 8, "bframe3": 8, "d": 8, "combine_column": 8, "both": 8, "modified2": 8, "modified1": 8, "modified3": 8, "intend": 8, "accur": 8, "interoper": 8, "most": 8, "probabl": 8, "actual": 8, "analys": 8, "convers": 8, "pd": 8}, "objects": {"": [[0, 0, 0, "-", "biocframe"]], "biocframe": [[0, 0, 0, "-", "BiocFrame"], [1, 0, 0, "-", "io"]], "biocframe.BiocFrame": [[0, 1, 1, "", "BiocFrame"], [0, 1, 1, "", "BiocFrameIter"], [0, 4, 1, "", "merge"], [0, 4, 1, "", "relaxed_combine_columns"], [0, 4, 1, "", "relaxed_combine_rows"]], "biocframe.BiocFrame.BiocFrame": [[0, 2, 1, "", "__array_ufunc__"], [0, 2, 1, "", "__copy__"], [0, 2, 1, "", "__deepcopy__"], [0, 2, 1, "", "__delitem__"], [0, 2, 1, "", "__getitem__"], [0, 2, 1, "", "__init__"], [0, 2, 1, "", "__iter__"], [0, 2, 1, "", "__len__"], [0, 2, 1, "", "__repr__"], [0, 2, 1, "", "__setitem__"], [0, 3, 1, "", "colnames"], [0, 2, 1, "", "column"], [0, 3, 1, "", "column_data"], [0, 3, 1, "", "column_names"], [0, 3, 1, "", "columns"], [0, 2, 1, "", "combine"], [0, 2, 1, "", "copy"], [0, 3, 1, "", "data"], [0, 3, 1, "", "dims"], [0, 2, 1, "", "from_pandas"], [0, 2, 1, "", "get_column"], [0, 2, 1, "", "get_column_data"], [0, 2, 1, "", "get_column_names"], [0, 2, 1, "", "get_data"], [0, 2, 1, "", "get_metadata"], [0, 2, 1, "", "get_row"], [0, 2, 1, "", "get_row_names"], [0, 2, 1, "", "get_slice"], [0, 2, 1, "", "has_column"], [0, 3, 1, "", "index"], [0, 3, 1, "", "metadata"], [0, 2, 1, "", "remove_column"], [0, 2, 1, "", "remove_columns"], [0, 2, 1, "", "row"], [0, 3, 1, "", "row_names"], [0, 3, 1, "", "rownames"], [0, 2, 1, "", "set_column"], [0, 2, 1, "", "set_column_data"], [0, 2, 1, "", "set_column_names"], [0, 2, 1, "", "set_columns"], [0, 2, 1, "", "set_metadata"], [0, 2, 1, "", "set_row_names"], [0, 2, 1, "", "set_slice"], [0, 3, 1, "", "shape"], [0, 2, 1, "", "slice"], [0, 2, 1, "", "split"], [0, 2, 1, "", "to_pandas"]], "biocframe.BiocFrame.BiocFrameIter": [[0, 2, 1, "", "__init__"], [0, 2, 1, "", "__iter__"], [0, 2, 1, "", "__next__"]], "biocframe.io": [[1, 0, 0, "-", "from_pandas"]], "biocframe.io.from_pandas": [[1, 4, 1, "", "from_pandas"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "function", "Python function"]}, "titleterms": {"biocfram": [0, 1, 2, 6], "packag": [0, 1], "subpackag": 0, "submodul": [0, 1], "modul": [0, 1], "content": [0, 1, 6], "io": 1, "from_panda": 1, "contributor": 3, "changelog": 4, "version": 4, "0": 4, "5": 4, "1": 4, "3": 4, "2": 4, "todo": 5, "contribut": 5, "issu": 5, "report": 5, "document": 5, "improv": 5, "code": 5, "submit": 5, "an": 5, "creat": 5, "environ": 5, "clone": 5, "repositori": 5, "implement": 5, "your": 5, "chang": 5, "troubleshoot": 5, "maintain": 5, "task": 5, "releas": 5, "indic": 6, "tabl": 6, "licens": 7, "bioconductor": 8, "like": 8, "data": 8, "frame": 8, "overview": 8, "construct": 8, "extract": 8, "set": 8, "prefer": 8, "approach": 8, "The": 8, "other": 8, "wai": 8, "combin": 8, "object": 8, "plai": 8, "nice": 8, "panda": 8, "further": 8, "read": 8}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"biocframe package": [[0, "biocframe-package"]], "Subpackages": [[0, "subpackages"]], "Submodules": [[0, "submodules"], [1, "submodules"]], "biocframe.BiocFrame module": [[0, "module-biocframe.BiocFrame"]], "Module contents": [[0, "module-biocframe"], [1, "module-biocframe.io"]], "biocframe.io package": [[1, "biocframe-io-package"]], "biocframe.io.from_pandas module": [[1, "module-biocframe.io.from_pandas"]], "biocframe": [[2, "biocframe"]], "Contributors": [[3, "contributors"]], "Changelog": [[4, "changelog"]], "Version 0.5.1": [[4, "version-0-5-1"]], "Version 0.5.0": [[4, "version-0-5-0"]], "Version 0.3": [[4, "version-0-3"]], "Version 0.2": [[4, "version-0-2"]], "Version 0.1": [[4, "version-0-1"]], "Todo": [[5, "id1"], [5, "id2"], [5, "id3"], [5, "id5"], [5, "id6"], [5, "id7"], [5, "id8"], [5, "id9"], [5, "id10"], [5, "id11"], [5, "id12"]], "Contributing": [[5, "contributing"]], "Issue Reports": [[5, "issue-reports"]], "Documentation Improvements": [[5, "documentation-improvements"]], "Code Contributions": [[5, "code-contributions"]], "Submit an issue": [[5, "submit-an-issue"]], "Create an environment": [[5, "create-an-environment"]], "Clone the repository": [[5, "clone-the-repository"]], "Implement your changes": [[5, "implement-your-changes"]], "Submit your contribution": [[5, "submit-your-contribution"]], "Troubleshooting": [[5, "troubleshooting"]], "Maintainer tasks": [[5, "maintainer-tasks"]], "Releases": [[5, "releases"]], "BiocFrame": [[6, "biocframe"]], "Contents": [[6, "contents"]], "Indices and tables": [[6, "indices-and-tables"]], "License": [[7, "license"]], "Bioconductor-like data frames": [[8, "bioconductor-like-data-frames"]], "Overview": [[8, "overview"]], "Construction": [[8, "construction"]], "Extracting data": [[8, "extracting-data"]], "Setting data": [[8, "setting-data"]], "Preferred approach": [[8, "preferred-approach"]], "The other way": [[8, "the-other-way"]], "Combining objects": [[8, "combining-objects"]], "Playing nice with pandas": [[8, "playing-nice-with-pandas"]], "Further reading": [[8, "further-reading"]]}, "indexentries": {"biocframe (class in biocframe.biocframe)": [[0, "biocframe.BiocFrame.BiocFrame"]], "biocframeiter (class in biocframe.biocframe)": [[0, "biocframe.BiocFrame.BiocFrameIter"]], "__array_ufunc__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__array_ufunc__"]], "__copy__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__copy__"]], "__deepcopy__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__deepcopy__"]], "__delitem__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__delitem__"]], "__getitem__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__getitem__"]], "__init__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__init__"]], "__init__() (biocframe.biocframe.biocframeiter method)": [[0, "biocframe.BiocFrame.BiocFrameIter.__init__"]], "__iter__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__iter__"]], "__iter__() (biocframe.biocframe.biocframeiter method)": [[0, "biocframe.BiocFrame.BiocFrameIter.__iter__"]], "__len__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__len__"]], "__next__() (biocframe.biocframe.biocframeiter method)": [[0, "biocframe.BiocFrame.BiocFrameIter.__next__"]], "__repr__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__repr__"]], "__setitem__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__setitem__"]], "biocframe": [[0, "module-biocframe"]], "biocframe.biocframe": [[0, "module-biocframe.BiocFrame"]], "colnames (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.colnames"]], "column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.column"]], "column_data (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.column_data"]], "column_names (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.column_names"]], "columns (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.columns"]], "combine() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.combine"]], "copy() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.copy"]], "data (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.data"]], "dims (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.dims"]], "from_pandas() (biocframe.biocframe.biocframe class method)": [[0, "biocframe.BiocFrame.BiocFrame.from_pandas"]], "get_column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_column"]], "get_column_data() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_column_data"]], "get_column_names() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_column_names"]], "get_data() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_data"]], "get_metadata() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_metadata"]], "get_row() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_row"]], "get_row_names() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_row_names"]], "get_slice() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_slice"]], "has_column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.has_column"]], "index (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.index"]], "merge() (in module biocframe.biocframe)": [[0, "biocframe.BiocFrame.merge"]], "metadata (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.metadata"]], "module": [[0, "module-biocframe"], [0, "module-biocframe.BiocFrame"], [1, "module-biocframe.io"], [1, "module-biocframe.io.from_pandas"]], "relaxed_combine_columns() (in module biocframe.biocframe)": [[0, "biocframe.BiocFrame.relaxed_combine_columns"]], "relaxed_combine_rows() (in module biocframe.biocframe)": [[0, "biocframe.BiocFrame.relaxed_combine_rows"]], "remove_column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.remove_column"]], "remove_columns() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.remove_columns"]], "row() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.row"]], "row_names (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.row_names"]], "rownames (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.rownames"]], "set_column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_column"]], "set_column_data() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_column_data"]], "set_column_names() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_column_names"]], "set_columns() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_columns"]], "set_metadata() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_metadata"]], "set_row_names() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_row_names"]], "set_slice() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_slice"]], "shape (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.shape"]], "slice() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.slice"]], "split() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.split"]], "to_pandas() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.to_pandas"]], "biocframe.io": [[1, "module-biocframe.io"]], "biocframe.io.from_pandas": [[1, "module-biocframe.io.from_pandas"]], "from_pandas() (in module biocframe.io.from_pandas)": [[1, "biocframe.io.from_pandas.from_pandas"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["api/biocframe", "api/biocframe.io", "api/modules", "authors", "changelog", "contributing", "index", "license", "readme"], "filenames": ["api/biocframe.rst", "api/biocframe.io.rst", "api/modules.rst", "authors.md", "changelog.md", "contributing.md", "index.md", "license.md", "readme.md"], "titles": ["biocframe package", "biocframe.io package", "biocframe", "Contributors", "Changelog", "Contributing", "BiocFrame", "License", "Bioconductor-like data frames"], "terms": {"io": [0, 2, 8], "from_panda": [0, 2, 8], "class": [0, 4, 5, 8], "data": [0, 2, 6], "none": [0, 8], "number_of_row": 0, "row_nam": [0, 2, 8], "column_nam": [0, 2, 8], "column_data": [0, 2, 8], "metadata": [0, 2, 8], "valid": [0, 5], "true": [0, 5, 8], "sourc": [0, 1, 5], "base": [0, 4, 5, 8], "object": [0, 4, 6], "i": [0, 4, 5, 7, 8], "an": [0, 7, 8], "altern": [0, 8], "datafram": [0, 4, 8], "support": [0, 8], "nest": [0, 8], "flexibl": [0, 4], "column": [0, 2, 4, 8], "type": [0, 1, 4, 8], "inspir": 0, "dframe": [0, 8], "from": [0, 4, 5, 7, 8], "bioconductor": 0, "": [0, 4, 5, 8], "s4vector": [0, 8], "ani": [0, 5, 7], "mai": [0, 4, 5], "us": [0, 4, 5, 7, 8], "provid": [0, 1, 4, 5, 7, 8], "ha": [0, 4, 8], "some": [0, 4, 8], "concept": [0, 5, 8], "height": 0, "defin": 0, "get_height": 0, "biocutil": [0, 4, 8], "thi": [0, 4, 5, 7, 8], "default": [0, 4, 8], "length": [0, 8], "__len__": [0, 2, 8], "The": [0, 5, 7], "abil": 0, "slice": [0, 2, 4, 8], "integ": 0, "indic": [0, 8], "implement": [0, 4, 8], "subset": [0, 8], "call": [0, 8], "__getitem__": [0, 2, 4, 8], "combin": [0, 2, 4, 6], "other": [0, 5, 7], "perform": 0, "assign": [0, 8], "allow": [0, 4, 8], "accept": [0, 8], "arbitrarili": [0, 8], "complex": [0, 8], "instanc": [0, 8], "__array_ufunc__": [0, 2], "func": 0, "method": [0, 1, 4, 5, 8], "input": [0, 1], "kwarg": 0, "interfac": [0, 5], "numpi": 0, "arrai": 0, "note": 0, "veri": [0, 5], "primit": 0, "need": [0, 5], "test": [0, 4, 5], "differ": [0, 5, 8], "return": [0, 1, 5], "same": [0, 5, 8], "caller": 0, "__copy__": [0, 2, 4], "A": [0, 4, 7, 8], "shallow": [0, 8], "copi": [0, 2, 5, 7, 8], "current": [0, 5], "__deepcopy__": [0, 2], "memo": 0, "_nil": 0, "deep": 0, "__delitem__": [0, 2], "name": [0, 4, 5, 8], "alia": [0, 1], "remove_column": [0, 2], "in_plac": [0, 8], "As": [0, 4], "mutat": [0, 8], "origin": [0, 5, 8], "warn": 0, "rais": 0, "arg": 0, "wrapper": 0, "around": 0, "get_column": [0, 2, 8], "get_slic": [0, 2], "obtain": [0, 7], "its": [0, 5], "paramet": [0, 4], "union": 0, "int": 0, "str": 0, "sequenc": [0, 8], "tupl": 0, "scalar": 0, "string": 0, "specifi": [0, 8], "retain": 0, "1": [0, 5, 6, 8], "first": [0, 5], "entri": 0, "row": [0, 2, 4, 8], "2": [0, 5, 6, 8], "while": [0, 4, 5], "second": 0, "If": [0, 5, 8], "achiev": [0, 8], "intern": [0, 4, 5], "new": [0, 5, 8], "contain": 0, "onli": [0, 1, 8], "just": [0, 5, 8], "argument": [0, 4, 8], "__init__": [0, 2], "initi": [0, 4], "option": [0, 4, 5], "dict": 0, "dictionari": [0, 8], "kei": 0, "valu": 0, "all": [0, 4, 5, 7], "must": 0, "have": [0, 5, 8], "empti": 0, "number": [0, 8], "infer": 0, "ar": [0, 4, 5, 8], "present": 0, "list": [0, 5, 8], "should": [0, 5], "miss": [0, 5], "order": [0, 5], "than": 0, "about": [0, 5], "addit": [0, 4, 5], "bool": 0, "__iter__": [0, 2], "iter": 0, "over": 0, "biocframeit": [0, 2], "__repr__": [0, 2], "represent": [0, 8], "__setitem__": [0, 2], "set_column": [0, 2, 8], "set_slic": [0, 2], "modifi": [0, 5, 7, 8], "place": [0, 8], "assum": [0, 5, 8], "expect": [0, 4, 5], "pass": [0, 4, 5], "onto": 0, "replac": [0, 5, 8], "These": [0, 8], "properti": [0, 8], "colnam": [0, 2], "get_column_nam": [0, 2, 8], "back": [0, 1, 8], "compat": [0, 1, 5], "get_column_data": [0, 2, 4], "panda": [0, 4, 6], "relaxed_combine_row": [0, 2, 4, 8], "get_data": [0, 2], "dim": [0, 2], "shape": [0, 2, 8], "classmethod": 0, "creat": [0, 8], "which": [0, 5, 8], "exist": [0, 8], "index": [0, 2, 4, 5, 6], "interest": [0, 5], "with_nam": [0, 4], "whether": [0, 7], "set": [0, 4, 6], "annot": 0, "each": 0, "where": 0, "correspond": [0, 8], "get_metadata": [0, 2], "get_row": [0, 2, 8], "access": [0, 4, 8], "avail": [0, 5], "see": [0, 5, 8], "get_row_nam": [0, 2], "suppli": 0, "instead": [0, 4, 5, 8], "occurr": 0, "along": [0, 8], "extract": [0, 6], "boolean": [0, 8], "thereof": 0, "normalize_subscript": 0, "treat": 0, "has_column": [0, 2], "fals": [0, 4, 8], "remov": [0, 4, 5], "conveni": 0, "posit": [0, 4], "either": [0, 5, 8], "refer": [0, 4, 5, 6, 8], "rownam": [0, 2], "add": [0, 4, 5, 8], "set_column_data": [0, 2, 8], "numbero": 0, "equal": [0, 8], "set_column_nam": [0, 2, 8], "uniqu": 0, "set_metadata": [0, 2, 8], "set_row_nam": [0, 2, 8], "given": 0, "mixtur": 0, "so": [0, 7, 8], "ignor": [0, 4], "split": [0, 2], "only_indic": 0, "repres": 0, "group": [0, 5], "frame": 0, "map": 0, "to_panda": [0, 2, 8], "convert": [0, 4], "obj": [0, 8], "__next__": [0, 2], "merg": [0, 2, 4, 5, 7, 8], "x": [0, 8], "join": [0, 8], "left": 0, "rename_duplicate_column": 0, "multipl": [0, 4], "togeth": 0, "common": 0, "yield": 0, "across": [0, 8], "ident": [0, 8], "locat": 0, "liter": 0, "inner": 0, "right": [0, 7], "outer": [0, 8], "strategi": 0, "For": [0, 5, 8], "we": [0, 5, 8], "consid": [0, 5], "last": 0, "respect": [0, 5], "duplic": 0, "non": [0, 5], "automat": [0, 5], "renam": 0, "error": [0, 5], "store": 0, "0": [0, 5, 6, 8], "otherwis": [0, 7, 8], "thei": [0, 5, 8], "relaxed_combine_column": [0, 2], "relax": 0, "version": [0, 5, 6, 8], "combine_row": [0, 8], "wherea": 0, "absent": 0, "fill": 0, "appropri": 0, "placehold": 0, "befor": [0, 4, 5], "One": 0, "more": [0, 4, 5, 8], "possibli": 0, "consist": [0, 4], "mask": 0, "packag": [2, 4, 5, 6, 8], "subpackag": 2, "submodul": 2, "modul": [2, 5, 6], "content": [2, 5], "jayaram": [3, 8], "kancherla": [3, 8], "gmail": 3, "com": [3, 5, 8], "aaron": 3, "lun": 3, "infinit": 3, "monkei": 3, "keyboard": 3, "move": 4, "biocfram": [4, 5, 8], "attach": 4, "output": 4, "can": [4, 5, 8], "turn": 4, "off": 4, "bugfix": [4, 5], "avoid": [4, 5, 8], "effect": 4, "when": [4, 5], "function": [4, 5, 8], "style": [4, 5, 8], "onc": [4, 5], "reduc": 4, "varieti": 4, "simplifi": [4, 5], "user": [4, 5, 8], "refactor": 4, "gener": [4, 5, 8], "releas": 4, "migrat": 4, "palat": 4, "googl": 4, "python": [4, 5], "guid": [4, 5], "major": [4, 5], "modif": [4, 8], "case": [4, 5, 8], "camelcas": 4, "now": 4, "snake_cas": 4, "In": [4, 5], "docstr": [4, 5], "document": [4, 6, 7, 8], "been": [4, 5], "updat": [4, 5, 8], "sphinx": [4, 5], "featur": [4, 5], "link": [4, 5], "also": [4, 5, 8], "privat": [4, 5], "special": 4, "dunder": 4, "e": [4, 5, 8], "g": [4, 5, 8], "etc": 4, "intersphinx": 4, "depend": [4, 5], "configur": [4, 5], "flake8": [4, 5], "ruff": 4, "black": [4, 5], "ad": [4, 5], "pyproject": 4, "toml": 4, "setup": [4, 5], "cfg": [4, 5], "less": 4, "annoi": 4, "pyscaffold": [4, 5], "myst": [4, 5], "parser": 4, "markdown": 4, "compil": [4, 5], "recommonmark": 4, "part": [4, 5, 8], "one": [4, 5], "pre": [4, 5], "commit": [4, 5], "run": [4, 5], "routin": 4, "task": [4, 6], "lint": 4, "format": 4, "everi": 4, "sometim": [4, 5], "verifi": 4, "bring": 4, "code": [4, 6], "creation": 4, "github": [4, 5, 8], "action": [4, 7], "suppos": 5, "TO": [5, 7], "BE": [5, 7], "exampl": [5, 8], "IT": 5, "accord": 5, "you": [5, 8], "servic": 5, "promot": 5, "model": 5, "similar": 5, "fork": 5, "pull": 5, "request": 5, "workflow": 5, "like": 5, "gitlab": 5, "bitbucket": 5, "might": [5, 8], "gerrit": 5, "notic": [5, 7], "url": [5, 8], "text": 5, "specif": 5, "terminologi": 5, "pleas": [5, 8], "make": [5, 8], "sure": 5, "check": [5, 8], "assumpt": [5, 8], "mind": 5, "thing": 5, "accordingli": [5, 8], "correct": 5, "bottom": 5, "want": [5, 8], "look": 5, "contributor": 5, "especi": 5, "project": [5, 8], "open": 5, "templat": 5, "few": 5, "extra": 5, "decid": 5, "includ": [5, 7], "mention": 5, "label": [5, 8], "tracker": 5, "autom": 5, "welcom": 5, "focus": 5, "get": [5, 8], "potenti": 5, "familiar": 5, "develop": 5, "process": 5, "kind": [5, 7], "appreci": 5, "git": 5, "never": 5, "collabor": 5, "previous": 5, "org": [5, 8], "resourc": 5, "excel": 5, "freecodecamp": 5, "consider": 5, "reason": 5, "doubt": 5, "softwar": [5, 7], "foundat": 5, "conduct": 5, "good": 5, "term": 5, "behavior": 5, "guidelin": 5, "experi": 5, "bug": 5, "don": 5, "t": 5, "anyth": 5, "feel": 5, "free": [5, 7], "fire": 5, "forget": 5, "close": 5, "search": [5, 6], "solut": 5, "wa": [5, 8], "alreadi": 5, "problem": 5, "solv": 5, "inform": 5, "program": [5, 8], "oper": [5, 8], "system": 5, "step": 5, "reproduc": 5, "try": 5, "reproduct": 5, "minim": 5, "still": 5, "illustr": 5, "face": 5, "By": [5, 8], "factor": 5, "help": [5, 6], "u": [5, 8], "identifi": 5, "root": 5, "caus": 5, "doc": 5, "them": 5, "readabl": 5, "coher": 5, "mistak": 5, "main": [5, 8], "mean": 5, "kept": 5, "done": 5, "wai": 5, "markup": 5, "languag": 5, "restructuredtext": 5, "commonmark": 5, "extens": 5, "host": 5, "follow": [5, 7], "tip": 5, "web": 5, "quick": 5, "propos": 5, "file": [5, 7], "mechan": 5, "tricki": 5, "normal": 5, "work": [5, 8], "perfectli": 5, "fine": 5, "quit": 5, "handi": 5, "out": [5, 7, 8], "navig": 5, "folder": 5, "find": 5, "would": 5, "click": 5, "littl": 5, "pencil": 5, "icon": 5, "top": 5, "editor": 5, "finish": 5, "edit": 5, "write": 5, "messag": 5, "form": 5, "page": [5, 6], "describ": 5, "made": 5, "what": 5, "motiv": 5, "behind": 5, "local": 5, "machin": 5, "tox": 5, "built": [5, 8], "server": [5, 8], "preview": 5, "browser": 5, "http": [5, 8], "localhost": 5, "8000": 5, "python3": 5, "m": 5, "directori": 5, "_build": 5, "html": 5, "explan": 5, "architectur": 5, "descript": 5, "design": 5, "principl": 5, "least": 5, "summari": 5, "easi": [5, 8], "start": [5, 8], "quickli": 5, "trivial": 5, "best": [5, 8], "discuss": 5, "subject": [5, 7], "often": [5, 8], "unnecessari": 5, "recommend": 5, "isol": 5, "virtual": 5, "instal": [5, 8], "easili": [5, 8], "via": [5, 8], "virtualenv": 5, "path": 5, "venv": 5, "bin": 5, "activ": 5, "miniconda": 5, "conda": [5, 8], "n": 5, "3": [5, 6, 8], "six": 5, "pytest": 5, "cov": 5, "account": 5, "do": [5, 7, 8], "button": 5, "under": 5, "disk": 5, "yourlogin": 5, "cd": 5, "pip": [5, 8], "setuptool": 5, "abl": 5, "import": [5, 8], "repl": 5, "item": 5, "come": 5, "lot": 5, "hook": 5, "being": [5, 8], "written": 5, "branch": [5, 8], "hold": 5, "checkout": 5, "b": [5, 8], "my": 5, "public": 5, "api": [5, 8], "yourself": 5, "author": [5, 6, 7, 8], "rst": 5, "re": 5, "record": 5, "fix": 5, "eventu": 5, "unit": 5, "moreov": 5, "highli": 5, "histori": 5, "log": 5, "graph": 5, "decor": 5, "pretti": 5, "onelin": 5, "abbrev": 5, "recur": 5, "commun": 5, "pattern": 5, "break": 5, "after": 5, "pipx": 5, "sever": 5, "av": 5, "everyth": 5, "push": 5, "remot": 5, "go": 5, "send": 5, "review": 5, "uncom": 5, "paragraph": 5, "detail": [5, 8], "pr": 5, "draft": 5, "mark": 5, "readi": 5, "feedback": 5, "continu": 5, "integr": 5, "ci": [5, 8], "requir": 5, "build": 5, "fetch": [5, 8], "tag": 5, "upstream": 5, "command": 5, "script": 5, "egg": 5, "complet": 5, "well": 5, "info": 5, "src": 5, "txt": 5, "recreat": 5, "r": [5, 8], "flag": 5, "reliabl": 5, "7": [5, 8], "OR": [5, 7], "troubl": 5, "weird": 5, "upon": 5, "dedic": 5, "binari": 5, "freshli": 5, "drop": 5, "interact": 5, "session": 5, "occur": 5, "pdb": 5, "k": 5, "OF": [5, 7], "THE": [5, 7], "fall": 5, "breakpoint": 5, "manual": 5, "section": 5, "pypi": [5, 8], "publicli": 5, "instruct": 5, "permiss": [5, 7], "success": 5, "v1": 5, "clean": 5, "up": 5, "dist": 5, "rm": 5, "rf": 5, "confus": 5, "old": 5, "dirti": 5, "hash": 5, "size": 5, "distribut": [5, 7], "too": 5, "big": 5, "500kb": 5, "unwant": 5, "clutter": 5, "accident": 5, "publish": [5, 7], "upload": 5, "correctli": 5, "definit": 5, "even": [5, 8], "though": 5, "focu": 5, "idea": 5, "collect": 5, "appli": 5, "sort": 5, "compani": 5, "proprietari": 5, "overview": 6, "construct": 6, "plai": 6, "nice": 6, "further": 6, "read": 6, "contribut": 6, "issu": 6, "report": 6, "improv": 6, "maintain": 6, "licens": 6, "changelog": 6, "5": [6, 8], "mit": 7, "copyright": 7, "c": [7, 8], "2022": 7, "genentech": 7, "inc": 7, "herebi": 7, "grant": 7, "charg": 7, "person": 7, "associ": 7, "deal": 7, "without": 7, "restrict": 7, "limit": 7, "sublicens": 7, "sell": 7, "permit": 7, "whom": 7, "furnish": 7, "condit": 7, "abov": [7, 8], "shall": 7, "substanti": 7, "portion": 7, "AS": 7, "warranti": 7, "express": 7, "impli": 7, "BUT": 7, "NOT": 7, "merchant": 7, "fit": 7, "FOR": 7, "particular": 7, "purpos": 7, "AND": 7, "noninfring": 7, "IN": 7, "NO": 7, "event": 7, "holder": 7, "liabl": 7, "claim": 7, "damag": 7, "liabil": 7, "contract": 7, "tort": 7, "aris": 7, "connect": 7, "WITH": 7, "badg": 8, "your": 8, "readm": 8, "statu": 8, "cirru": 8, "svg": 8, "readthedoc": 8, "latest": 8, "en": 8, "stabl": 8, "coveral": 8, "img": 8, "shield": 8, "v": 8, "forg": 8, "vn": 8, "anaconda": 8, "monthli": 8, "download": 8, "pepi": 8, "tech": 8, "month": 8, "twitter": 8, "social": 8, "friendli": 8, "advantag": 8, "long": 8, "insid": 8, "To": 8, "simpli": 8, "ensembl": 8, "ens00001": 8, "ens00002": 8, "ens00003": 8, "symbol": 8, "map1a": 8, "bin1": 8, "esr1": 8, "bframe": 8, "print": 8, "anoth": 8, "rang": 8, "chr": 8, "chr1": 8, "chr2": 8, "chr3": 8, "1000": 8, "1100": 8, "5000": 8, "end": 8, "4000": 8, "5500": 8, "bframe2": 8, "row1": 8, "row2": 8, "row3": 8, "directli": 8, "individu": 8, "And": 8, "vector": 8, "column1": 8, "short": 8, "hand": 8, "singl": 8, "encourag": 8, "inadvert": 8, "larger": 8, "structur": 8, "column2": 8, "unchang": 8, "new_col_nam": 8, "4": 8, "chang": 8, "foo": 8, "bar": 8, "alpha": 8, "bravo": 8, "charli": 8, "entir": 8, "column_sourc": 8, "hgnc": 8, "direct": 8, "silent": 8, "nonetheless": 8, "testfram": 8, "6": 8, "similarli": 8, "could": 8, "y": 8, "f": 8, "set_": 8, "It": 8, "anywher": 8, "els": 8, "safer": 8, "variou": 8, "bframe1": 8, "odd": 8, "9": 8, "8": 8, "11": 8, "33": 8, "55": 8, "77": 8, "99": 8, "22": 8, "44": 8, "66": 8, "88": 8, "10": 8, "bframe3": 8, "d": 8, "combine_column": 8, "both": 8, "modified2": 8, "modified1": 8, "modified3": 8, "intend": 8, "accur": 8, "interoper": 8, "most": 8, "probabl": 8, "actual": 8, "analys": 8, "convers": 8, "pd": 8}, "objects": {"": [[0, 0, 0, "-", "biocframe"]], "biocframe": [[0, 0, 0, "-", "BiocFrame"], [1, 0, 0, "-", "io"]], "biocframe.BiocFrame": [[0, 1, 1, "", "BiocFrame"], [0, 1, 1, "", "BiocFrameIter"], [0, 4, 1, "", "merge"], [0, 4, 1, "", "relaxed_combine_columns"], [0, 4, 1, "", "relaxed_combine_rows"]], "biocframe.BiocFrame.BiocFrame": [[0, 2, 1, "", "__array_ufunc__"], [0, 2, 1, "", "__copy__"], [0, 2, 1, "", "__deepcopy__"], [0, 2, 1, "", "__delitem__"], [0, 2, 1, "", "__getitem__"], [0, 2, 1, "", "__init__"], [0, 2, 1, "", "__iter__"], [0, 2, 1, "", "__len__"], [0, 2, 1, "", "__repr__"], [0, 2, 1, "", "__setitem__"], [0, 3, 1, "", "colnames"], [0, 2, 1, "", "column"], [0, 3, 1, "", "column_data"], [0, 3, 1, "", "column_names"], [0, 3, 1, "", "columns"], [0, 2, 1, "", "combine"], [0, 2, 1, "", "copy"], [0, 3, 1, "", "data"], [0, 3, 1, "", "dims"], [0, 2, 1, "", "from_pandas"], [0, 2, 1, "", "get_column"], [0, 2, 1, "", "get_column_data"], [0, 2, 1, "", "get_column_names"], [0, 2, 1, "", "get_data"], [0, 2, 1, "", "get_metadata"], [0, 2, 1, "", "get_row"], [0, 2, 1, "", "get_row_names"], [0, 2, 1, "", "get_slice"], [0, 2, 1, "", "has_column"], [0, 3, 1, "", "index"], [0, 3, 1, "", "metadata"], [0, 2, 1, "", "remove_column"], [0, 2, 1, "", "remove_columns"], [0, 2, 1, "", "row"], [0, 3, 1, "", "row_names"], [0, 3, 1, "", "rownames"], [0, 2, 1, "", "set_column"], [0, 2, 1, "", "set_column_data"], [0, 2, 1, "", "set_column_names"], [0, 2, 1, "", "set_columns"], [0, 2, 1, "", "set_metadata"], [0, 2, 1, "", "set_row_names"], [0, 2, 1, "", "set_slice"], [0, 3, 1, "", "shape"], [0, 2, 1, "", "slice"], [0, 2, 1, "", "split"], [0, 2, 1, "", "to_pandas"]], "biocframe.BiocFrame.BiocFrameIter": [[0, 2, 1, "", "__init__"], [0, 2, 1, "", "__iter__"], [0, 2, 1, "", "__next__"]], "biocframe.io": [[1, 0, 0, "-", "from_pandas"]], "biocframe.io.from_pandas": [[1, 4, 1, "", "from_pandas"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "function", "Python function"]}, "titleterms": {"biocfram": [0, 1, 2, 6], "packag": [0, 1], "subpackag": 0, "submodul": [0, 1], "modul": [0, 1], "content": [0, 1, 6], "io": 1, "from_panda": 1, "contributor": 3, "changelog": 4, "version": 4, "0": 4, "5": 4, "1": 4, "3": 4, "2": 4, "todo": 5, "contribut": 5, "issu": 5, "report": 5, "document": 5, "improv": 5, "code": 5, "submit": 5, "an": 5, "creat": 5, "environ": 5, "clone": 5, "repositori": 5, "implement": 5, "your": 5, "chang": 5, "troubleshoot": 5, "maintain": 5, "task": 5, "releas": 5, "indic": 6, "tabl": 6, "licens": 7, "bioconductor": 8, "like": 8, "data": 8, "frame": 8, "overview": 8, "construct": 8, "extract": 8, "set": 8, "prefer": 8, "approach": 8, "The": 8, "other": 8, "wai": 8, "combin": 8, "object": 8, "plai": 8, "nice": 8, "panda": 8, "further": 8, "read": 8}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"biocframe package": [[0, "biocframe-package"]], "Subpackages": [[0, "subpackages"]], "Submodules": [[0, "submodules"], [1, "submodules"]], "biocframe.BiocFrame module": [[0, "module-biocframe.BiocFrame"]], "Module contents": [[0, "module-biocframe"], [1, "module-biocframe.io"]], "biocframe.io package": [[1, "biocframe-io-package"]], "biocframe.io.from_pandas module": [[1, "module-biocframe.io.from_pandas"]], "biocframe": [[2, "biocframe"]], "Contributors": [[3, "contributors"]], "Changelog": [[4, "changelog"]], "Version 0.5.1": [[4, "version-0-5-1"]], "Version 0.5.0": [[4, "version-0-5-0"]], "Version 0.3": [[4, "version-0-3"]], "Version 0.2": [[4, "version-0-2"]], "Version 0.1": [[4, "version-0-1"]], "Todo": [[5, "id1"], [5, "id2"], [5, "id3"], [5, "id5"], [5, "id6"], [5, "id7"], [5, "id8"], [5, "id9"], [5, "id10"], [5, "id11"], [5, "id12"]], "Contributing": [[5, "contributing"]], "Issue Reports": [[5, "issue-reports"]], "Documentation Improvements": [[5, "documentation-improvements"]], "Code Contributions": [[5, "code-contributions"]], "Submit an issue": [[5, "submit-an-issue"]], "Create an environment": [[5, "create-an-environment"]], "Clone the repository": [[5, "clone-the-repository"]], "Implement your changes": [[5, "implement-your-changes"]], "Submit your contribution": [[5, "submit-your-contribution"]], "Troubleshooting": [[5, "troubleshooting"]], "Maintainer tasks": [[5, "maintainer-tasks"]], "Releases": [[5, "releases"]], "BiocFrame": [[6, "biocframe"]], "Contents": [[6, "contents"]], "Indices and tables": [[6, "indices-and-tables"]], "License": [[7, "license"]], "Bioconductor-like data frames": [[8, "bioconductor-like-data-frames"]], "Overview": [[8, "overview"]], "Construction": [[8, "construction"]], "Extracting data": [[8, "extracting-data"]], "Setting data": [[8, "setting-data"]], "Preferred approach": [[8, "preferred-approach"]], "The other way": [[8, "the-other-way"]], "Combining objects": [[8, "combining-objects"]], "Playing nice with pandas": [[8, "playing-nice-with-pandas"]], "Further reading": [[8, "further-reading"]]}, "indexentries": {"biocframe (class in biocframe.biocframe)": [[0, "biocframe.BiocFrame.BiocFrame"]], "biocframeiter (class in biocframe.biocframe)": [[0, "biocframe.BiocFrame.BiocFrameIter"]], "__array_ufunc__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__array_ufunc__"]], "__copy__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__copy__"]], "__deepcopy__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__deepcopy__"]], "__delitem__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__delitem__"]], "__getitem__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__getitem__"]], "__init__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__init__"]], "__init__() (biocframe.biocframe.biocframeiter method)": [[0, "biocframe.BiocFrame.BiocFrameIter.__init__"]], "__iter__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__iter__"]], "__iter__() (biocframe.biocframe.biocframeiter method)": [[0, "biocframe.BiocFrame.BiocFrameIter.__iter__"]], "__len__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__len__"]], "__next__() (biocframe.biocframe.biocframeiter method)": [[0, "biocframe.BiocFrame.BiocFrameIter.__next__"]], "__repr__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__repr__"]], "__setitem__() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.__setitem__"]], "biocframe": [[0, "module-biocframe"]], "biocframe.biocframe": [[0, "module-biocframe.BiocFrame"]], "colnames (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.colnames"]], "column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.column"]], "column_data (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.column_data"]], "column_names (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.column_names"]], "columns (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.columns"]], "combine() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.combine"]], "copy() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.copy"]], "data (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.data"]], "dims (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.dims"]], "from_pandas() (biocframe.biocframe.biocframe class method)": [[0, "biocframe.BiocFrame.BiocFrame.from_pandas"]], "get_column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_column"]], "get_column_data() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_column_data"]], "get_column_names() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_column_names"]], "get_data() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_data"]], "get_metadata() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_metadata"]], "get_row() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_row"]], "get_row_names() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_row_names"]], "get_slice() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.get_slice"]], "has_column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.has_column"]], "index (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.index"]], "merge() (in module biocframe.biocframe)": [[0, "biocframe.BiocFrame.merge"]], "metadata (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.metadata"]], "module": [[0, "module-biocframe"], [0, "module-biocframe.BiocFrame"], [1, "module-biocframe.io"], [1, "module-biocframe.io.from_pandas"]], "relaxed_combine_columns() (in module biocframe.biocframe)": [[0, "biocframe.BiocFrame.relaxed_combine_columns"]], "relaxed_combine_rows() (in module biocframe.biocframe)": [[0, "biocframe.BiocFrame.relaxed_combine_rows"]], "remove_column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.remove_column"]], "remove_columns() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.remove_columns"]], "row() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.row"]], "row_names (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.row_names"]], "rownames (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.rownames"]], "set_column() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_column"]], "set_column_data() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_column_data"]], "set_column_names() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_column_names"]], "set_columns() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_columns"]], "set_metadata() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_metadata"]], "set_row_names() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_row_names"]], "set_slice() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.set_slice"]], "shape (biocframe.biocframe.biocframe property)": [[0, "biocframe.BiocFrame.BiocFrame.shape"]], "slice() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.slice"]], "split() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.split"]], "to_pandas() (biocframe.biocframe.biocframe method)": [[0, "biocframe.BiocFrame.BiocFrame.to_pandas"]], "biocframe.io": [[1, "module-biocframe.io"]], "biocframe.io.from_pandas": [[1, "module-biocframe.io.from_pandas"]], "from_pandas() (in module biocframe.io.from_pandas)": [[1, "biocframe.io.from_pandas.from_pandas"]]}}) \ No newline at end of file