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
1 participant
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.
This pull request includes updates to improve project documentation, streamline file organization, and fix inconsistencies in file paths. The most significant changes involve a complete rewrite of the
README.mdfor clarity and usability, adjustments to the Makefile for consistency in file paths, and the removal of outdated or redundant files.Documentation Updates:
README.md: Completely rewritten to provide a clearer structure, updated project goals, prerequisites, quick start instructions, and workflow details. It also includes a new table for dataset access methods and Makefile targets.docs/TABLES.md: Removed outdated documentation on event pairing and linking logic to avoid redundancy and maintain focus on updated workflows.File Path Adjustments:
Makefile: Updated the output path for therun_idus_downloadtarget to store files indata/idmc_idu/instead ofdata_raw/idmc_idu/for consistency with other datasets..pre-commit-config.yaml: AddedREADME.mdto the list of excluded files for pre-commit checks.Removal of Redundant Files:
notebooks/exploration.ipynb: Deleted an outdated notebook that contained exploratory scripts for CSV files, as it is no longer aligned with the current project structure.