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

feat: change "incidence matrix" naming to "biadjacency matrix" #962

Merged
merged 2 commits into from Nov 21, 2023

Conversation

maelle
Copy link
Contributor

@maelle maelle commented Nov 13, 2023

Fix #900

Copy link
Contributor

aviator-app bot commented Nov 13, 2023

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes.
Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This PR was merged using Aviator.


See the real-time status of this PR on the Aviator webapp.

Use the Aviator Chrome Extension to see the status of your PR within GitHub.

@maelle
Copy link
Contributor Author

maelle commented Nov 13, 2023

This becomes a small blocker for #716 since it edits the zzz-deprecate.R script.

R/conversion.R Outdated
#' @keywords internal
#' @export
as_incidence_matrix <- function(...) {
lifecycle::deprecate_soft("1.5.2", "as_incidence_matrix()", "as_biadjacency_matrix()")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@krlmlr what version number should we use here?

Copy link
Member

@szhorvat szhorvat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please update the documentation text to refer to "bipartite adjacency matrix" instead of "incidence matrix" in all places? Add just one note along these lines:

Some authors refer to the bipartite adjacency matrix as the "bipartite incidence matrix". igraph 1.6.0 and later does not use this naming to avoid confusion with the edge-vertex incidence matrix.

@aviator-app aviator-app bot added the blocked label Nov 13, 2023
Copy link
Contributor

aviator-app bot commented Nov 13, 2023

This pull request failed to merge: this PR has a review with changes requested (the review must be approved or dismissed before merging). Remove the blocked label to re-queue.

@maelle maelle requested a review from szhorvat November 13, 2023 14:41
@krlmlr
Copy link
Contributor

krlmlr commented Nov 13, 2023

@szhorvat: Please remove the "blocked" label when good.

@szhorvat
Copy link
Member

@krlmlr Looks good to me, but are you going to do 1.5.2 instead of 1.6.0? There are a lot of changes here, worth a version bump ...

@krlmlr
Copy link
Contributor

krlmlr commented Nov 13, 2023

Why 1.5.2?

@szhorvat
Copy link
Member

szhorvat commented Nov 13, 2023

The version numbers in this PR are all 1.5.2, and @maelle was asking above about what version number you were going to use. See her comment on conversion.R.

I think 1.6.0 makes more sense, but it's your decision.

Whatever the decision, we should be consistent about it in the docs.

@szhorvat
Copy link
Member

@krlmlr This looks fine for me, other than the version. I'll leave it to you to deal with what version is mentioned in the docs.

Copy link
Contributor

aviator-app bot commented Nov 14, 2023

This pull request failed to merge: PR cannot be automatically rebased, please rebase manually to continue. Remove the blocked label to re-queue.

Additional debug info: Failed to rebase this PR onto the latest changes from the base branch. You will probably need to rebase this PR manually and resolve conflicts).

@krlmlr krlmlr removed the blocked label Nov 18, 2023
@aviator-app aviator-app bot added the blocked label Nov 18, 2023
Copy link
Contributor

aviator-app bot commented Nov 18, 2023

This pull request failed to merge: PR cannot be automatically rebased, please rebase manually to continue. Remove the blocked label to re-queue.

Additional debug info: Failed to rebase this PR onto the latest changes from the base branch. You will probably need to rebase this PR manually and resolve conflicts).

@krlmlr krlmlr changed the title feat!: change "incidence matrix" naming to "biadjacency matrix" feat: change "incidence matrix" naming to "biadjacency matrix" Nov 18, 2023
@krlmlr
Copy link
Contributor

krlmlr commented Nov 18, 2023

Thanks! This PR doesn't seem to be breaking anything.

@krlmlr
Copy link
Contributor

krlmlr commented Nov 18, 2023

@maelle: Can you please work on the test coverage? Probably it's sufficient to test that the deprecated variants give the same results as the original, plus a deprecation warning?

@aviator-app aviator-app bot removed the mergequeue label Nov 20, 2023
Copy link
Contributor

aviator-app bot commented Nov 20, 2023

This pull request can't be queued because it's currently a draft.

@maelle maelle requested a review from krlmlr November 20, 2023 09:32
@maelle maelle marked this pull request as ready for review November 20, 2023 10:37
Copy link
Contributor

@krlmlr krlmlr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good! Can you please set the "mergequeue" label when done?

src/cpp11.cpp Outdated Show resolved Hide resolved
@krlmlr krlmlr removed the blocked label Nov 20, 2023
@krlmlr
Copy link
Contributor

krlmlr commented Nov 21, 2023

Thanks!

@aviator-app aviator-app bot merged commit ce2f63a into igraph:main Nov 21, 2023
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

"incidence matrix" naming should be changed to "biadjacency matrix"
3 participants