Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the docs #124

Merged
merged 8 commits into from
Nov 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/cooler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ Cooler API
.. automethod:: chromosomes
.. automethod:: finalize
.. automethod:: path
.. automethod:: resolutions
.. automethod:: resolution
2 changes: 2 additions & 0 deletions src/file.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,8 @@ void declare_file_class(nb::module_ &m) {
"Check whether a given normalization is available.");
file.def("weights", &file::weights, nb::arg("name"), nb::arg("divisive") = true,
"Fetch the balancing weights for the given normalization method.",
nb::sig("def weights(self, name: str, divisive: bool = True) -> "
"numpy.ndarray[float]"),
nb::rv_policy::take_ownership);
file.def(
"weights", &file::weights_df, nb::arg("names"), nb::arg("divisive") = true,
Expand Down
2 changes: 1 addition & 1 deletion src/hic_file_writer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ void HiCFileWriter::bind(nb::module_ &m) {

writer.def("add_pixels", &hictkpy::HiCFileWriter::add_pixels,
nb::call_guard<nb::gil_scoped_release>(),
nb::sig("def add_pixels(self, pixels: pd.DataFrame) -> None"), nb::arg("pixels"),
nb::sig("def add_pixels(self, pixels: pandas.DataFrame) -> None"), nb::arg("pixels"),
"Add pixels from a pandas DataFrame containing pixels in COO or BG2 format (i.e. "
"either with columns=[bin1_id, bin2_id, count] or with columns=[chrom1, start1, end1, "
"chrom2, start2, end2, count].");
Expand Down
2 changes: 1 addition & 1 deletion src/singlecell_file.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ void declare_singlecell_file_class(nb::module_& m) {
nb::rv_policy::take_ownership);
scell_file.def("cells", &singlecell_file::get_cells, "Get the list of available cells.",
nb::rv_policy::move);
scell_file.def("__getitem__", &singlecell_file::getitem,
scell_file.def("__getitem__", &singlecell_file::getitem, nb::arg("cell_id"),
"Open the Cooler file corresponding to the cell ID given as input.",
nb::rv_policy::move);
}
Expand Down
Loading