Repository navigation
Add project and PhysioNet citations with BibTeX - #184
Open
tompollard wants to merge 4 commits into
Open
tompollard wants to merge 4 commits into
tompollard wants to merge 4 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
physionet cite SLUGfor the latest published project citation and the current standard PhysioNet citation.--version VERSIONto cite a specific release; text and JSON output report the resolved version.--bibtexfor two copyable BibTeX entries and--jsonfor structured output.PhysioNetClient.projects.get_citations(...), citation models, documentation, and tests.The version API supplies the project citation text. The platform does not expose project BibTeX through that API, so the package reads the BibTeX already published on the project's PhysioNet page. If an older project has no BibTeX,
--bibtexfails clearly rather than generating incomplete author data. The standard PhysioNet reference is kept in the package. The retired Goldberger et al. (2000) reference is excluded from every output format.When no version is specified, the package sends a HEAD request to the platform's exact-project
/content/SLUG/route and reads its redirect to the latest release. It avoids downloading the full published-project catalog, which can time out.Verification
pytest -q— 164 passed, 1 skippedgit diff --check— passedphysionet cite mimic-iv-demoandphysionet cite mimic-iv-demo --bibtex— passed