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

Make column names singular #78

Open
yarikoptic opened this issue May 15, 2024 · 1 comment
Open

Make column names singular #78

yarikoptic opened this issue May 15, 2024 · 1 comment
Assignees
Labels
consistency Aspect requiring special treatment/logic outside of generic common principles

Comments

@yarikoptic
Copy link
Contributor

yarikoptic commented May 15, 2024

Generalization of the

Looking at column names we do not have consistency.

grep '^[a-z]' src/schema/objects/columns.yaml | grep -v __
abbreviation:
age:
cardiac:
channel:
color:
component:
detector_type:
derived_from:
desc_id:
description:
dimension:
duration:
filename:
handedness:
hemisphere:
high_cutoff:
hplc_recovery_fractions:
impedance:
index:
low_cutoff:
manufacturer:
mapping:
material:
metabolite_parent_fraction:
metabolite_polar_fraction:
notch:
onset:
pathology:
participant_id:
plasma_radioactivity:
reference_frame:
respiratory:
response_time:
sample_id:
sample_type:
sampling_frequency:
session_id:
sex:
short_channel:
size:
software_filters:
species:
status:
status_description:
stim_file:
strain:
strain_rrid:
time:
trial_type:
trigger:
units:
volume_type:
wavelength_nominal:
wavelength_actual:
wavelength_emission_actual:
whole_blood_radioactivity:
x:
y:
z:
template_x:
template_y:
template_z:
Dirty list: grep '^[a-z]' src/schema/objects/columns.yaml | grep -v __ | grep 's:'
handedness:
hplc_recovery_fractions:
software_filters:
species:
status:
units:

so in addition to units, and excluding software_filters (which is a string for a list but without clear formatting stated) there is also hplc_recovery_fractions

hplc_recovery_fractions:
  name: hplc_recovery_fractions
  display_name: HPLC recovery fractions
  description: |
    HPLC recovery fractions (the fraction of activity that gets loaded onto the HPLC).
  type: number
  unit: arbitrary

which is scalar (I thought that they might be a list ;) ), but especially since a scalar -- we should make them into singular as well IMHO and add to common principles (if not there) that should be singular.

@yarikoptic
Copy link
Contributor Author

hplc_recovery_fractions is for PET, hence let me inquire @bids-standard/raw-pet -- do you agree that it would be ok to make it singular hplc_recovery_fraction as all the other columns are singular and other fraction(s) too:

❯ grep fraction: src/schema/objects/columns.yaml
metabolite_parent_fraction:
metabolite_polar_fraction:

@yarikoptic yarikoptic added the consistency Aspect requiring special treatment/logic outside of generic common principles label May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency Aspect requiring special treatment/logic outside of generic common principles
Projects
Status: Todo
Development

No branches or pull requests

1 participant