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

Refactoring #294

Merged
merged 7 commits into from
Nov 13, 2024
Merged

Refactoring #294

merged 7 commits into from
Nov 13, 2024

Conversation

trangdata
Copy link
Collaborator

@trangdata trangdata commented Nov 13, 2024

Prepping for openalexR 2.0.0 (or maybe a minor version bump instead?)

I'm trying to make the final column names of oa2df more "canonical" — largely agreeing with what OpenAlex has originally. I will update #211 once this PR is merged.

  • Breaking changes in column names in the output of oa_fetch:

    • so is now source_display_name
    • so_id is now source_id
    • ab is now abstract
    • url is now landing_page_url
    • the nested columns under authors no longer have the au prefix
  • Deprecated oa2bibliometrix(). Instead, use bibliometrix::convert2df() (from the bibliometrix R package). (per Massimo's suggestion)

Closes #270.

@rkrug
Copy link

rkrug commented Nov 13, 2024

As this new version breaks compatibility of existing code, I would definitely make it 2.0.0.

Also I would like to suggest to thread carefully with this, and

a) show a warning when loading the package / using the function affected that the new version is incompatible with older versions and what heeds to be changed in existing code to make it compatible or

b) add an (intermediate) parameter backwards_compatible which if TRUE uses the old names but shows a deprecation warning (the default value can be FALSE.

I completely agree with going to the original OpenAlex names, but the change should be done carefully to avoid confusion of the users if scripts are not working anymore and one has to dig into the version history of the package to find the changes.

@trangdata trangdata merged commit a9c91d6 into main Nov 13, 2024
7 checks passed
@trangdata trangdata deleted the all-institutions branch November 19, 2024 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

oa_fetch () missing additional author's institutions?
4 participants