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

Gdr 2419 #79

Merged
merged 5 commits into from
Feb 27, 2024
Merged

Gdr 2419 #79

merged 5 commits into from
Feb 27, 2024

Conversation

gladkia
Copy link
Contributor

@gladkia gladkia commented Feb 26, 2024

Description

Improve pkgdown site

What changed?

Logistic checklist

  • Package version bumped
  • Changelog updated

Screenshots (optional)

@gladkia gladkia requested a review from a team as a code owner February 26, 2024 09:17
@gladkia gladkia requested review from darsoo and bczech and removed request for a team February 26, 2024 09:17
Copy link
Contributor

@j-smola j-smola left a comment

Choose a reason for hiding this comment

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

Maybe we could shorten list of groups?

  1. IMO get_test_data() should be in "Test data class"
  2. "Assert utils" nad "Utils" maybe one group - just "Utils"?
  3. Maybe "Convert Pset object to gDR object" and "Convert MAE to PSet object" could be one group "Pset object converter"
  4. "Correction helpers" and "Exception helpers" could be one section?
  5. I would propose to move some function from "Load data" into "Correction helpers": check_metadata_against_spaces(), check_metadata_field_names(), check_metadata_headers(), check_metadata_names(), check_metadata_req_col_names()
  6. Maybe "Correction helpers" could be "Input data validator" since these function operate on the raw data before transformation into gDR model, right? (or something different but more descriptive fror users)

R/load_files.R Show resolved Hide resolved
@gladkia
Copy link
Contributor Author

gladkia commented Feb 27, 2024

Maybe we could shorten list of groups?

  1. IMO get_test_data() should be in "Test data class"
  2. "Assert utils" nad "Utils" maybe one group - just "Utils"?
  3. Maybe "Convert Pset object to gDR object" and "Convert MAE to PSet object" could be one group "Pset object converter"
  4. "Correction helpers" and "Exception helpers" could be one section?
  5. I would propose to move some function from "Load data" into "Correction helpers": check_metadata_against_spaces(), check_metadata_field_names(), check_metadata_headers(), check_metadata_names(), check_metadata_req_col_names()
  6. Maybe "Correction helpers" could be "Input data validator" since these function operate on the raw data before transformation into gDR model, right? (or something different but more descriptive fror users)

Sounds great. Done.

@gladkia gladkia merged commit 78c1d9c into main Feb 27, 2024
4 of 5 checks passed
@gladkia gladkia deleted the GDR-2419 branch February 27, 2024 14:57
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.

3 participants