Contents:
@@ -74,216 +73,8 @@| - | - |
| - | - |
| - |
| - | - |
| - |
| - | - |
| - |
| - |
|
-
| - | - |
|
-
|
-
| - | - |
| - |
| - | - |
Contents:
@@ -82,12 +81,6 @@RoamGraphRoamGraph.db_pathRoamGraph._id_title_mapRoamGraph._graphRoamGraph._node_indexRoamGraph._orphansRoamGraph._is_connectedRoamGraph._duplicate_titlesRoamGraph._contains_dup_titlesRoamGraph.IDsRoamGraph.backlink_indexRoamGraph.file_indexRoamGraph.filter_tags()RoamGraph.fnamesRoamGraph.graphRoamGraph.id_title_mapRoamGraph.init_empty()RoamGraph.linksRoamGraph.misc_linksRoamGraph.node()RoamGraph.node_id()RoamGraph.node_indexRoamGraph.node_links()RoamGraph.node_title()RoamGraph.nodesRoamGraph.remove_orphans()RoamGraph.sizeRoamGraph.titlesRoamNode
-RoamGraphRoamGraph.db_pathRoamGraph._id_title_mapRoamGraph._graphRoamGraph._node_indexRoamGraph._orphansRoamGraph._is_connectedRoamGraph._duplicate_titlesRoamGraph._contains_dup_titlesRoamGraph.IDsRoamGraph.backlink_indexRoamGraph.file_indexRoamGraph.filter_tags()RoamGraph.fnamesRoamGraph.graphRoamGraph.id_title_mapRoamGraph.init_empty()RoamGraph.linksRoamGraph.misc_linksRoamGraph.node()RoamGraph.node_id()RoamGraph.node_indexRoamGraph.node_links()RoamGraph.node_title()RoamGraph.nodesRoamGraph.remove_orphans()RoamGraph.sizeRoamGraph.titlesRoamNode
-Bases: object
Store information of org-roam graph.
By default, the nodes in the _node_index are ordered ascending on
-the node IDs. In the documentation, the words “collection”, “network”,
-“graph”, all mean the same thing: the graph with nodes the org-roam nodes
-and edges determined by backlinks in the org-roam collection.
Path to org-roam database connected to graph
-str
-Map with keys the id of nodes and values the titles of the corresponding nodes
-dict[str,str]
-networkx graph representation of the collection
nx.MultiDiGraph
-Map with keys the ID of nodes and values the RoamNode object that corresponds
dict[str, RoamNode]
-List of orphans in network. An orphan node is one with no links connecting it to any -other node
-list[RoamNode]
-Tracks if network is connected (i.e. has no orphans)
-bool
-List of duplicated titles in network, used for warning user
-list[str]
-Whether the collection has duplicated titles
-bool
-Return list of IDs present in network
-list of IDs in network
-list[str]
-Examples
-FIXME: Add docs.
-Return index for node backlinks of the collection
-When a node in the collection has a reference to another node in the -collection, it is said to have a backlink to that node. These backlinks -provide the main nonhierarchical structure of the collection, and compactly -express relations of different nodes to each other.
-dict with keys the IDs of nodes and values the list of backlinks -in the node
-dict[str, list[str]]
-Examples
-FIXME: Add docs.
-Return index of filenames of collection
-dict with keys the IDs of nodes and values the filename of the file -containing that node
-dict[str, str]
-Examples
-FIXME: Add docs.
-Filter network by collection of tags
-tags (Iterable[str]) – Tags to filter by
exclude (bool) – To exclude or not
Filtered collection (as a copy)
-Examples
-FIXME: Add docs.
-Return list of filenames in network
-base (bool) – get just basename of file
-list of filenames in network
-list[str]
-Examples
-FIXME: Add docs.
-Return networkx graph representation of collection
-An org-roam collection naturally forms the structure of a -multi directed graph: a graph with direction-sensitive edges -allowing multiple edges between any two nodes.
-Multi directed graph representation of the collection
-nx.MultiDiGraph
-Examples
-FIXME: Add docs.
-Return dictionary of how the network maps IDs to titles
-dict with keys node IDs and values the corresponding title of the -node
-dic[str, str]
-Examples
-FIXME: Add docs.
-Initialize empty RoamNode object
-RoamNode object with default fields initialized
-Return dict of node IDs and their backlinks
-dict with keys IDs of nodes and values the list of backlinks in that -node
-dict[str, list[str]]
-Examples
-FIXME: Add docs.
-Return list of lists of miscellaneous links
-dict with keys node IDs and values the list of miscellaneous IDs for -corresponding node
-dict[str, list[str]]
-Examples
-FIXME: Add docs.
-Return node object
-Internally a node is of class orgroamtools.data.RoamNode, which stores -basic information about a node like ID, title, filename, and its backlinks
-identifier (str) – Identifier for node. Can be title or ID
-RoamNode object of node
-AttributeError – Raised if node cannot be found
-Return ID of node
-org-roam uses org-mode’s internal :ID: property creation to uniquely identify nodes -in the collection.
-identifier (str) – Title of node
-ID of node
-str
-AttributeError – Raised if no node matches the provided title
-Return index of nodes
-The node_index is hashed by node ID, since this is the only -value guaranteed to be unique to each org-roam node across -various configurations.
-dict with keys the IDs of nodes and values the RoamNode object -of the node with that ID
-dict[str, RoamNode]
-Return links for a particular node
-A node’s links is the collection of links made in the body of the node desired. -By convention, a node will always refer to itself
-identifier (str) – Identifier for node. Can be title or ID
-List of IDs of nodes the provided node refers to
-list[str]
-AttributeError – Raised if identifier cannot be found in the collection
-Return title of node
-The title of a node is the name given to the note file. -If your org-roam node is its own file, this is the #+title: property. -If you org-roam node is a heading, this is the heading title
-identifier (str) – ID of node
-Title of node
-str
-AttributeError – Raised if ID not be found in collection
-Return list of nodes in network
-list of nodes in network
-list[RoamNode]
-Examples
-FIXME: Add docs.
-Remove orphans from network
-This method returns a new network that has orphans removed.
-Connected subcollection of self
-Examples
-FIXME: Add docs.
-Return size of collection
-Tuple (num nodes , num links)
-Return list of titles present in network
-list of titles of nodes in network
-list[str]
-Examples
-FIXME: Add docs.
-Bases: object
Store relevant org-roam node information
-A node is an atomic note known to the org-roam database. -It is uniquely determined by an ID generated at the time of creation, but -has other identifiers and information that a user might want to know about.
-Filename of org-roam node
-str
-Title of org-roam node
-str
-Unique org ID of org-roam node
-str
-Collection of tags of org-roam node
-set[str]
-List of backlinks in org-roam node
-list[str]
-List of miscellaneous links that are not links to other nodes
-list[OrgLink]
-| - o | ||
| - |
- orgroamtools | - |
| - |
- orgroamtools.data | - |
Contents:
diff --git a/searchindex.js b/searchindex.js index 74253f7..5732a9e 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["index", "modules", "orgroamtools"], "filenames": ["index.rst", "modules.rst", "orgroamtools.rst"], "titles": ["Welcome to orgroamtools\u2019s documentation!", "orgroamtools", "orgroamtools package"], "terms": {"packag": [0, 1], "submodul": [0, 1], "data": [0, 1], "modul": [0, 1], "index": [0, 2], "search": 0, "page": 0, "roamgraph": [1, 2], "db_path": [1, 2], "_id_title_map": [1, 2], "_graph": [1, 2], "_node_index": [1, 2], "_orphan": [1, 2], "_is_connect": [1, 2], "_duplicate_titl": [1, 2], "_contains_dup_titl": [1, 2], "id": [1, 2], "backlink_index": [1, 2], "file_index": [1, 2], "filter_tag": [1, 2], "fname": [1, 2], "graph": [1, 2], "id_title_map": [1, 2], "init_empti": [1, 2], "link": [1, 2], "misc_link": [1, 2], "node": [1, 2], "node_id": [1, 2], "node_index": [1, 2], "node_link": [1, 2], "node_titl": [1, 2], "remove_orphan": [1, 2], "size": [1, 2], "titl": [1, 2], "roamnod": [1, 2], "tag": [1, 2], "backlink": [1, 2], "content": 1, "class": 2, "db": 2, "str": 2, "base": 2, "object": 2, "store": 2, "inform": 2, "org": 2, "roam": 2, "By": 2, "default": 2, "ar": 2, "order": 2, "ascend": 2, "In": 2, "document": 2, "word": 2, "collect": 2, "network": 2, "all": 2, "mean": 2, "same": 2, "thing": 2, "edg": 2, "determin": 2, "path": 2, "databas": 2, "connect": 2, "type": 2, "map": 2, "kei": 2, "valu": 2, "correspond": 2, "dict": 2, "networkx": 2, "represent": 2, "nx": 2, "multidigraph": 2, "list": 2, "orphan": 2, "an": 2, "i": 2, "one": 2, "ani": 2, "other": 2, "track": 2, "e": 2, "ha": 2, "bool": 2, "duplic": 2, "us": 2, "warn": 2, "user": 2, "whether": 2, "properti": 2, "return": 2, "present": 2, "exampl": 2, "fixm": 2, "add": 2, "doc": 2, "when": 2, "refer": 2, "anoth": 2, "said": 2, "have": 2, "These": 2, "provid": 2, "main": 2, "nonhierarch": 2, "structur": 2, "compactli": 2, "express": 2, "relat": 2, "differ": 2, "each": 2, "filenam": 2, "file": 2, "contain": 2, "iter": 2, "exclud": 2, "true": 2, "filter": 2, "paramet": 2, "To": 2, "copi": 2, "get": 2, "just": 2, "basenam": 2, "natur": 2, "form": 2, "multi": 2, "direct": 2, "sensit": 2, "allow": 2, "multipl": 2, "between": 2, "two": 2, "dictionari": 2, "how": 2, "dic": 2, "classmethod": 2, "initi": 2, "empti": 2, "field": 2, "orglink": 2, "miscellan": 2, "identifi": 2, "intern": 2, "which": 2, "basic": 2, "about": 2, "like": 2, "its": 2, "can": 2, "rais": 2, "attributeerror": 2, "cannot": 2, "found": 2, "mode": 2, "": 2, "creation": 2, "uniqu": 2, "match": 2, "The": 2, "hash": 2, "sinc": 2, "thi": 2, "onli": 2, "guarante": 2, "across": 2, "variou": 2, "configur": 2, "particular": 2, "A": 2, "made": 2, "bodi": 2, "desir": 2, "convent": 2, "alwai": 2, "itself": 2, "name": 2, "given": 2, "note": 2, "If": 2, "your": 2, "own": 2, "you": 2, "head": 2, "remov": 2, "from": 2, "method": 2, "new": 2, "subcollect": 2, "self": 2, "tupl": 2, "int": 2, "num": 2, "set": 2, "relev": 2, "atom": 2, "known": 2, "It": 2, "gener": 2, "time": 2, "might": 2, "want": 2, "know": 2}, "objects": {"": [[2, 0, 0, "-", "orgroamtools"]], "orgroamtools": [[2, 0, 0, "-", "data"]], "orgroamtools.data": [[2, 1, 1, "", "RoamGraph"], [2, 1, 1, "", "RoamNode"]], "orgroamtools.data.RoamGraph": [[2, 2, 1, "", "IDs"], [2, 3, 1, "", "_contains_dup_titles"], [2, 3, 1, "", "_duplicate_titles"], [2, 3, 1, "", "_graph"], [2, 3, 1, "", "_id_title_map"], [2, 3, 1, "", "_is_connected"], [2, 3, 1, "", "_node_index"], [2, 3, 1, "", "_orphans"], [2, 2, 1, "", "backlink_index"], [2, 3, 1, "", "db_path"], [2, 2, 1, "", "file_index"], [2, 4, 1, "", "filter_tags"], [2, 2, 1, "", "fnames"], [2, 2, 1, "", "graph"], [2, 2, 1, "", "id_title_map"], [2, 4, 1, "", "init_empty"], [2, 2, 1, "", "links"], [2, 2, 1, "", "misc_links"], [2, 4, 1, "", "node"], [2, 4, 1, "", "node_id"], [2, 2, 1, "", "node_index"], [2, 4, 1, "", "node_links"], [2, 4, 1, "", "node_title"], [2, 2, 1, "", "nodes"], [2, 4, 1, "", "remove_orphans"], [2, 2, 1, "", "size"], [2, 2, 1, "", "titles"]], "orgroamtools.data.RoamNode": [[2, 3, 1, "", "backlinks"], [2, 3, 1, "id0", "fname"], [2, 3, 1, "id1", "id"], [2, 3, 1, "", "links"], [2, 3, 1, "id2", "misc_links"], [2, 3, 1, "id3", "tags"], [2, 3, 1, "id4", "title"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:property", "3": "py:attribute", "4": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "property", "Python property"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "titleterms": {"welcom": 0, "orgroamtool": [0, 1, 2], "": 0, "document": 0, "content": [0, 2], "indic": 0, "tabl": 0, "packag": 2, "submodul": 2, "data": 2, "modul": 2}, "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": 60}, "alltitles": {"Welcome to orgroamtools\u2019s documentation!": [[0, "welcome-to-orgroamtools-s-documentation"]], "Contents:": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "orgroamtools": [[1, "orgroamtools"]], "orgroamtools package": [[2, "orgroamtools-package"]], "Submodules": [[2, "submodules"]], "orgroamtools.data module": [[2, "module-orgroamtools.data"]], "Module contents": [[2, "module-orgroamtools"]]}, "indexentries": {"ids (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.IDs"]], "roamgraph (class in orgroamtools.data)": [[2, "orgroamtools.data.RoamGraph"]], "roamnode (class in orgroamtools.data)": [[2, "orgroamtools.data.RoamNode"]], "_contains_dup_titles (orgroamtools.data.roamgraph attribute)": [[2, "orgroamtools.data.RoamGraph._contains_dup_titles"]], "_duplicate_titles (orgroamtools.data.roamgraph attribute)": [[2, "orgroamtools.data.RoamGraph._duplicate_titles"]], "_graph (orgroamtools.data.roamgraph attribute)": [[2, "orgroamtools.data.RoamGraph._graph"]], "_id_title_map (orgroamtools.data.roamgraph attribute)": [[2, "orgroamtools.data.RoamGraph._id_title_map"]], "_is_connected (orgroamtools.data.roamgraph attribute)": [[2, "orgroamtools.data.RoamGraph._is_connected"]], "_node_index (orgroamtools.data.roamgraph attribute)": [[2, "orgroamtools.data.RoamGraph._node_index"]], "_orphans (orgroamtools.data.roamgraph attribute)": [[2, "orgroamtools.data.RoamGraph._orphans"]], "backlink_index (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.backlink_index"]], "backlinks (orgroamtools.data.roamnode attribute)": [[2, "orgroamtools.data.RoamNode.backlinks"]], "db_path (orgroamtools.data.roamgraph attribute)": [[2, "orgroamtools.data.RoamGraph.db_path"]], "file_index (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.file_index"]], "filter_tags() (orgroamtools.data.roamgraph method)": [[2, "orgroamtools.data.RoamGraph.filter_tags"]], "fname (orgroamtools.data.roamnode attribute)": [[2, "id0"], [2, "orgroamtools.data.RoamNode.fname"]], "fnames (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.fnames"]], "graph (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.graph"]], "id (orgroamtools.data.roamnode attribute)": [[2, "id1"], [2, "orgroamtools.data.RoamNode.id"]], "id_title_map (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.id_title_map"]], "init_empty() (orgroamtools.data.roamgraph class method)": [[2, "orgroamtools.data.RoamGraph.init_empty"]], "links (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.links"]], "links (orgroamtools.data.roamnode attribute)": [[2, "orgroamtools.data.RoamNode.links"]], "misc_links (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.misc_links"]], "misc_links (orgroamtools.data.roamnode attribute)": [[2, "id2"], [2, "orgroamtools.data.RoamNode.misc_links"]], "module": [[2, "module-orgroamtools"], [2, "module-orgroamtools.data"]], "node() (orgroamtools.data.roamgraph method)": [[2, "orgroamtools.data.RoamGraph.node"]], "node_id() (orgroamtools.data.roamgraph method)": [[2, "orgroamtools.data.RoamGraph.node_id"]], "node_index (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.node_index"]], "node_links() (orgroamtools.data.roamgraph method)": [[2, "orgroamtools.data.RoamGraph.node_links"]], "node_title() (orgroamtools.data.roamgraph method)": [[2, "orgroamtools.data.RoamGraph.node_title"]], "nodes (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.nodes"]], "orgroamtools": [[2, "module-orgroamtools"]], "orgroamtools.data": [[2, "module-orgroamtools.data"]], "remove_orphans() (orgroamtools.data.roamgraph method)": [[2, "orgroamtools.data.RoamGraph.remove_orphans"]], "size (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.size"]], "tags (orgroamtools.data.roamnode attribute)": [[2, "id3"], [2, "orgroamtools.data.RoamNode.tags"]], "title (orgroamtools.data.roamnode attribute)": [[2, "id4"], [2, "orgroamtools.data.RoamNode.title"]], "titles (orgroamtools.data.roamgraph property)": [[2, "orgroamtools.data.RoamGraph.titles"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["index", "modules", "orgroamtools"], "filenames": ["index.rst", "modules.rst", "orgroamtools.rst"], "titles": ["Welcome to orgroamtools\u2019s documentation!", "orgroamtools", "orgroamtools package"], "terms": {"packag": [0, 1], "index": 0, "modul": [0, 1], "search": 0, "page": 0, "submodul": 1, "data": 1, "content": 1}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"welcom": 0, "orgroamtool": [0, 1, 2], "": 0, "document": 0, "content": [0, 2], "indic": 0, "tabl": 0, "packag": 2, "submodul": 2, "data": 2, "modul": 2}, "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": 60}, "alltitles": {"Welcome to orgroamtools\u2019s documentation!": [[0, "welcome-to-orgroamtools-s-documentation"]], "Contents:": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "orgroamtools": [[1, "orgroamtools"]], "orgroamtools package": [[2, "orgroamtools-package"]], "Submodules": [[2, "submodules"]], "orgroamtools.data module": [[2, "orgroamtools-data-module"]], "Module contents": [[2, "module-contents"]]}, "indexentries": {}}) \ No newline at end of file