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

Document multiple operations in imeta() #22

Closed
montesmariana opened this issue Mar 15, 2023 · 0 comments
Closed

Document multiple operations in imeta() #22

montesmariana opened this issue Mar 15, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@montesmariana
Copy link
Collaborator

The definition and documentation of imeta() suggest that the operations argument requires a named list with "operation", "attribute", "value", "units".
However, it also works with a list of such lists, and the body of the function tries to determine whether it's a list or a list of lists.

I would suggest:

  • Change the definition to operations = list(), without names.
  • Adapt the documentation so that it's clear that the list is a list of lists, each with at least 'operation', and optionally 'attribute', 'value' and 'units'. (Or should the optionality be different?)
    • The code would internally take care of turning the missing values to NULL.
    • The code would check and force that operations is a list of lists.
    • Eventually it could work with dataframes (one row per AVU, and columns 'operation', 'attribute', 'value', 'units')

If you agree, I can make the changes (at least to the documentation).

MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue May 27, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue May 27, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue May 27, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue May 31, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue May 31, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue Jun 1, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue Jun 1, 2023
trel pushed a commit that referenced this issue Jun 1, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue Jun 1, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue Jun 1, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue Jun 3, 2023
MartinSchobben added a commit to MartinSchobben/irods_client_library_rirods that referenced this issue Jun 3, 2023
@trel trel added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Development

No branches or pull requests

3 participants