Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
juba committed Apr 5, 2024
1 parent 2f03d68 commit d6593c0
Show file tree
Hide file tree
Showing 5 changed files with 187 additions and 187 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
d2f04eb7
41194c4c
2 changes: 1 addition & 1 deletion reference/Lifemap.html
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ <h2 id="toc-title">On this page</h2>

<section id="pylifemap.Lifemap" class="level1">
<h1>Lifemap</h1>
<p><code>Lifemap(self, data, *, locate=True, taxid_col='taxid', x_col='pylifemap_x', y_col='pylifemap_y', zoom=5, legend_width=None, width=DEFAULT_WIDTH, height=DEFAULT_HEIGHT)</code></p>
<p><code>Lifemap(self, data, *, taxid_col='taxid', zoom=5, legend_width=None, width=DEFAULT_WIDTH, height=DEFAULT_HEIGHT)</code></p>


</section>
Expand Down
326 changes: 163 additions & 163 deletions search.json
Original file line number Diff line number Diff line change
@@ -1,167 +1,4 @@
[
{
"objectID": "reference/aggregate_count.html",
"href": "reference/aggregate_count.html",
"title": "aggregate_count",
"section": "",
"text": "aggregate_count(d, *, result_col='n', taxid_col='taxid')\nNodes count aggregation along branches.\nAggregates nodes count in a DataFrame with taxonomy ids along the branches of the lifemap tree.\n\n\n\n\n\nName\nType\nDescription\nDefault\n\n\n\n\nd\npd.DataFrame | pl.DataFrame\nDataFrame to aggregate data from.\nrequired\n\n\nresult_col\nstr\nName of the column created to store the counts, by default “n”.\n'n'\n\n\ntaxid_col\nstr\nName of the d column containing taxonomy ids, by default “taxid”.\n'taxid'\n\n\n\n\n\n\n\n\n\n\n\n\n\nType\nDescription\n\n\n\n\npl.DataFrame\nAggregated DataFrame.\n\n\n\n\n\n\naggregate_num : aggregation of a numeric variable.\naggregate_freq : aggregation of the values counts of a categorical variable.\n\n\n\n&gt;&gt;&gt; from pylifemap import aggregate_count\n&gt;&gt;&gt; import polars as pl\n&gt;&gt;&gt; d = pl.DataFrame({\"taxid\": [33154, 33090, 2]})\n&gt;&gt;&gt; aggregate_count(d)\nshape: (5, 2)\n┌───────┬─────┐\n│ taxid ┆ n │\n│ --- ┆ --- │\n│ i32 ┆ u32 │\n╞═══════╪═════╡\n│ 0 ┆ 3 │\n│ 2 ┆ 1 │\n│ 2759 ┆ 2 │\n│ 33090 ┆ 1 │\n│ 33154 ┆ 1 │\n└───────┴─────┘",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/aggregate_count.html#parameters",
"href": "reference/aggregate_count.html#parameters",
"title": "aggregate_count",
"section": "",
"text": "Name\nType\nDescription\nDefault\n\n\n\n\nd\npd.DataFrame | pl.DataFrame\nDataFrame to aggregate data from.\nrequired\n\n\nresult_col\nstr\nName of the column created to store the counts, by default “n”.\n'n'\n\n\ntaxid_col\nstr\nName of the d column containing taxonomy ids, by default “taxid”.\n'taxid'",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/aggregate_count.html#returns",
"href": "reference/aggregate_count.html#returns",
"title": "aggregate_count",
"section": "",
"text": "Type\nDescription\n\n\n\n\npl.DataFrame\nAggregated DataFrame.",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/aggregate_count.html#see-also",
"href": "reference/aggregate_count.html#see-also",
"title": "aggregate_count",
"section": "",
"text": "aggregate_num : aggregation of a numeric variable.\naggregate_freq : aggregation of the values counts of a categorical variable.",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/aggregate_count.html#examples",
"href": "reference/aggregate_count.html#examples",
"title": "aggregate_count",
"section": "",
"text": "&gt;&gt;&gt; from pylifemap import aggregate_count\n&gt;&gt;&gt; import polars as pl\n&gt;&gt;&gt; d = pl.DataFrame({\"taxid\": [33154, 33090, 2]})\n&gt;&gt;&gt; aggregate_count(d)\nshape: (5, 2)\n┌───────┬─────┐\n│ taxid ┆ n │\n│ --- ┆ --- │\n│ i32 ┆ u32 │\n╞═══════╪═════╡\n│ 0 ┆ 3 │\n│ 2 ┆ 1 │\n│ 2759 ┆ 2 │\n│ 33090 ┆ 1 │\n│ 33154 ┆ 1 │\n└───────┴─────┘",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/Lifemap.html",
"href": "reference/Lifemap.html",
"title": "Lifemap",
"section": "",
"text": "Lifemap\nLifemap(self, data, *, locate=True, taxid_col='taxid', x_col='pylifemap_x', y_col='pylifemap_y', zoom=5, legend_width=None, width=DEFAULT_WIDTH, height=DEFAULT_HEIGHT)",
"crumbs": [
"Reference",
"Lifemap class",
"Lifemap"
]
},
{
"objectID": "reference/aggregate_cat.html",
"href": "reference/aggregate_cat.html",
"title": "aggregate_cat",
"section": "",
"text": "aggregate_cat\naggregate_cat(d, column, *, keep_leaves=False, taxid_col='taxid')"
},
{
"objectID": "development.html",
"href": "development.html",
"title": "Development notes",
"section": "",
"text": "To install pylifemap from git:\npip install git+https://github.com/juba/pylifemap.git"
},
{
"objectID": "development.html#install-from-git",
"href": "development.html#install-from-git",
"title": "Development notes",
"section": "",
"text": "To install pylifemap from git:\npip install git+https://github.com/juba/pylifemap.git"
},
{
"objectID": "development.html#install-fom-source",
"href": "development.html#install-fom-source",
"title": "Development notes",
"section": "Install fom source",
"text": "Install fom source\nIf you want to build pylifemap from source, you’ll have to follow these steps:\n\nInstall node.js\nInstall hatch dependency management system\nClone the pylifemap repository\nInstall Python dependencies with : hatch shell\nInstall JavaScript dependencies with : npm install --workspaces --include-root-workspace"
},
{
"objectID": "development.html#widget-javascript-modification-and-bundling",
"href": "development.html#widget-javascript-modification-and-bundling",
"title": "Development notes",
"section": "Widget JavaScript modification and bundling",
"text": "Widget JavaScript modification and bundling\nEach time the widget JavaScript or CSS code is modified in the src/js/ or packages/lifemapjs directories, it must be bundled with one of the following commands in pylifemap:\n# Bundle only once\nnpm run bundle\n# Or, to bundle and watch for code change\nnpm run dev\nThe result is put into src/pylifemap/static."
},
{
"objectID": "development.html#maintenance-notes",
"href": "development.html#maintenance-notes",
"title": "Development notes",
"section": "Maintenance notes",
"text": "Maintenance notes\n\nReleases\n\nChange version in NEWS.md and src/pylifemap/__about__.py\nRelease the Python package with hatch build and hatch publish in pylifemap\nTag the version in git\nCreate a release on Github\nBump to dev version in pyproject.toml and NEWS.md"
},
{
"objectID": "changelog.html",
"href": "changelog.html",
"title": "Changelog",
"section": "",
"text": "Development version, work in progress"
},
{
"objectID": "changelog.html#pylifemap-0.0.1-dev",
"href": "changelog.html#pylifemap-0.0.1-dev",
"title": "Changelog",
"section": "",
"text": "Development version, work in progress"
},
{
"objectID": "usage.html",
"href": "usage.html",
"title": "Usage",
"section": "",
"text": "Usage instructions."
},
{
"objectID": "index.html",
"href": "index.html",
"title": "pylifemap",
"section": "",
"text": "pylifemap is a jupyter widget allowing to visualize taxonomy data on Lifemap."
},
{
"objectID": "index.html#overview",
"href": "index.html#overview",
"title": "pylifemap",
"section": "",
"text": "pylifemap is a jupyter widget allowing to visualize taxonomy data on Lifemap."
},
{
"objectID": "index.html#installation-and-usage",
"href": "index.html#installation-and-usage",
"title": "pylifemap",
"section": "Installation and usage",
"text": "Installation and usage\nFor the moment the package can only be installed from Github:\npip install git+https://github.com/juba/pylifemap.git\nUsage gives more detailed usage instructions."
},
{
"objectID": "index.html#credits",
"href": "index.html#credits",
"title": "pylifemap",
"section": "Credits",
"text": "Credits\n\nThe iucn data files in the data/ directory have been generated from The IUCN Red List of Threatened Species dataset (DOI 10.15468/0qnb58).\nVisualizations are powered by Open Layers and deck.gl.\nThe widget is developed thanks to the anywidget framework.\nThis documentation website is generated by Quarto and quartodoc."
},
{
"objectID": "reference/aggregate_freq.html",
"href": "reference/aggregate_freq.html",
Expand Down Expand Up @@ -222,6 +59,18 @@
"aggregate_freq"
]
},
{
"objectID": "reference/Lifemap.html",
"href": "reference/Lifemap.html",
"title": "Lifemap",
"section": "",
"text": "Lifemap\nLifemap(self, data, *, taxid_col='taxid', zoom=5, legend_width=None, width=DEFAULT_WIDTH, height=DEFAULT_HEIGHT)",
"crumbs": [
"Reference",
"Lifemap class",
"Lifemap"
]
},
{
"objectID": "reference/aggregate_num.html",
"href": "reference/aggregate_num.html",
Expand Down Expand Up @@ -294,6 +143,76 @@
"aggregate_num"
]
},
{
"objectID": "index.html",
"href": "index.html",
"title": "pylifemap",
"section": "",
"text": "pylifemap is a jupyter widget allowing to visualize taxonomy data on Lifemap."
},
{
"objectID": "index.html#overview",
"href": "index.html#overview",
"title": "pylifemap",
"section": "",
"text": "pylifemap is a jupyter widget allowing to visualize taxonomy data on Lifemap."
},
{
"objectID": "index.html#installation-and-usage",
"href": "index.html#installation-and-usage",
"title": "pylifemap",
"section": "Installation and usage",
"text": "Installation and usage\nFor the moment the package can only be installed from Github:\npip install git+https://github.com/juba/pylifemap.git\nUsage gives more detailed usage instructions."
},
{
"objectID": "index.html#credits",
"href": "index.html#credits",
"title": "pylifemap",
"section": "Credits",
"text": "Credits\n\nThe iucn data files in the data/ directory have been generated from The IUCN Red List of Threatened Species dataset (DOI 10.15468/0qnb58).\nVisualizations are powered by Open Layers and deck.gl.\nThe widget is developed thanks to the anywidget framework.\nThis documentation website is generated by Quarto and quartodoc."
},
{
"objectID": "development.html",
"href": "development.html",
"title": "Development notes",
"section": "",
"text": "To install pylifemap from git:\npip install git+https://github.com/juba/pylifemap.git"
},
{
"objectID": "development.html#install-from-git",
"href": "development.html#install-from-git",
"title": "Development notes",
"section": "",
"text": "To install pylifemap from git:\npip install git+https://github.com/juba/pylifemap.git"
},
{
"objectID": "development.html#install-fom-source",
"href": "development.html#install-fom-source",
"title": "Development notes",
"section": "Install fom source",
"text": "Install fom source\nIf you want to build pylifemap from source, you’ll have to follow these steps:\n\nInstall node.js\nInstall hatch dependency management system\nClone the pylifemap repository\nInstall Python dependencies with : hatch shell\nInstall JavaScript dependencies with : npm install --workspaces --include-root-workspace"
},
{
"objectID": "development.html#widget-javascript-modification-and-bundling",
"href": "development.html#widget-javascript-modification-and-bundling",
"title": "Development notes",
"section": "Widget JavaScript modification and bundling",
"text": "Widget JavaScript modification and bundling\nEach time the widget JavaScript or CSS code is modified in the src/js/ or packages/lifemapjs directories, it must be bundled with one of the following commands in pylifemap:\n# Bundle only once\nnpm run bundle\n# Or, to bundle and watch for code change\nnpm run dev\nThe result is put into src/pylifemap/static."
},
{
"objectID": "development.html#maintenance-notes",
"href": "development.html#maintenance-notes",
"title": "Development notes",
"section": "Maintenance notes",
"text": "Maintenance notes\n\nReleases\n\nChange version in NEWS.md and src/pylifemap/__about__.py\nRelease the Python package with hatch build and hatch publish in pylifemap\nTag the version in git\nCreate a release on Github\nBump to dev version in pyproject.toml and NEWS.md"
},
{
"objectID": "usage.html",
"href": "usage.html",
"title": "Usage",
"section": "",
"text": "Usage instructions."
},
{
"objectID": "reference/index.html",
"href": "reference/index.html",
Expand Down Expand Up @@ -323,5 +242,86 @@
"crumbs": [
"Reference"
]
},
{
"objectID": "reference/aggregate_count.html",
"href": "reference/aggregate_count.html",
"title": "aggregate_count",
"section": "",
"text": "aggregate_count(d, *, result_col='n', taxid_col='taxid')\nNodes count aggregation along branches.\nAggregates nodes count in a DataFrame with taxonomy ids along the branches of the lifemap tree.\n\n\n\n\n\nName\nType\nDescription\nDefault\n\n\n\n\nd\npd.DataFrame | pl.DataFrame\nDataFrame to aggregate data from.\nrequired\n\n\nresult_col\nstr\nName of the column created to store the counts, by default “n”.\n'n'\n\n\ntaxid_col\nstr\nName of the d column containing taxonomy ids, by default “taxid”.\n'taxid'\n\n\n\n\n\n\n\n\n\n\n\n\n\nType\nDescription\n\n\n\n\npl.DataFrame\nAggregated DataFrame.\n\n\n\n\n\n\naggregate_num : aggregation of a numeric variable.\naggregate_freq : aggregation of the values counts of a categorical variable.\n\n\n\n&gt;&gt;&gt; from pylifemap import aggregate_count\n&gt;&gt;&gt; import polars as pl\n&gt;&gt;&gt; d = pl.DataFrame({\"taxid\": [33154, 33090, 2]})\n&gt;&gt;&gt; aggregate_count(d)\nshape: (5, 2)\n┌───────┬─────┐\n│ taxid ┆ n │\n│ --- ┆ --- │\n│ i32 ┆ u32 │\n╞═══════╪═════╡\n│ 0 ┆ 3 │\n│ 2 ┆ 1 │\n│ 2759 ┆ 2 │\n│ 33090 ┆ 1 │\n│ 33154 ┆ 1 │\n└───────┴─────┘",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/aggregate_count.html#parameters",
"href": "reference/aggregate_count.html#parameters",
"title": "aggregate_count",
"section": "",
"text": "Name\nType\nDescription\nDefault\n\n\n\n\nd\npd.DataFrame | pl.DataFrame\nDataFrame to aggregate data from.\nrequired\n\n\nresult_col\nstr\nName of the column created to store the counts, by default “n”.\n'n'\n\n\ntaxid_col\nstr\nName of the d column containing taxonomy ids, by default “taxid”.\n'taxid'",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/aggregate_count.html#returns",
"href": "reference/aggregate_count.html#returns",
"title": "aggregate_count",
"section": "",
"text": "Type\nDescription\n\n\n\n\npl.DataFrame\nAggregated DataFrame.",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/aggregate_count.html#see-also",
"href": "reference/aggregate_count.html#see-also",
"title": "aggregate_count",
"section": "",
"text": "aggregate_num : aggregation of a numeric variable.\naggregate_freq : aggregation of the values counts of a categorical variable.",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/aggregate_count.html#examples",
"href": "reference/aggregate_count.html#examples",
"title": "aggregate_count",
"section": "",
"text": "&gt;&gt;&gt; from pylifemap import aggregate_count\n&gt;&gt;&gt; import polars as pl\n&gt;&gt;&gt; d = pl.DataFrame({\"taxid\": [33154, 33090, 2]})\n&gt;&gt;&gt; aggregate_count(d)\nshape: (5, 2)\n┌───────┬─────┐\n│ taxid ┆ n │\n│ --- ┆ --- │\n│ i32 ┆ u32 │\n╞═══════╪═════╡\n│ 0 ┆ 3 │\n│ 2 ┆ 1 │\n│ 2759 ┆ 2 │\n│ 33090 ┆ 1 │\n│ 33154 ┆ 1 │\n└───────┴─────┘",
"crumbs": [
"Reference",
"Aggregation functions",
"aggregate_count"
]
},
{
"objectID": "reference/aggregate_cat.html",
"href": "reference/aggregate_cat.html",
"title": "aggregate_cat",
"section": "",
"text": "aggregate_cat\naggregate_cat(d, column, *, keep_leaves=False, taxid_col='taxid')"
},
{
"objectID": "changelog.html",
"href": "changelog.html",
"title": "Changelog",
"section": "",
"text": "Development version, work in progress"
},
{
"objectID": "changelog.html#pylifemap-0.0.1-dev",
"href": "changelog.html#pylifemap-0.0.1-dev",
"title": "Changelog",
"section": "",
"text": "Development version, work in progress"
}
]
2 changes: 1 addition & 1 deletion site_libs/bootstrap/bootstrap.min.css

Large diffs are not rendered by default.

Loading

0 comments on commit d6593c0

Please sign in to comment.