question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Rename temporal_derivative_distribution_repair to tddr

See original GitHub issue

Can we rename temporal_derivative_distribution_repair to just tddr? I really think that the function name is too long (39 characters) - it makes it impossible to stay within the 79 character limit without using ugly \ line breaks, e.g.:

from mne.preprocessing.nirs import temporal_derivative_distribution_repair as tddr  # 82 characters

I think renaming to tddr is not problematic because the function is in the nirs subpackage, and TDDR is a commonly known abbreviation in the NIRS community (googling for “nirs tddr” immediately brings up several results with the correct method).

This issue came up in https://github.com/cbrnr/mnelab/pull/145 that @rob-luke is working on. He’d probably be fine with renaming because that’s what he initially proposed.

And while we’re at it, I’d like to rename beer_lambert_law to beer_lambert as well (we’d save 4 chars without losing any meaning).

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:38 (38 by maintainers)

github_iconTop GitHub Comments

2reactions
larsonercommented, May 20, 2020

Let’s do the alias, it allows the shortest-name and longest-name to be maximally happy

1reaction
rob-lukecommented, May 19, 2020

There is much more information in the name than the acronym. It tells me it acts on temporal information, that it repairs the signal based on distribution information.

If I put myself in the role of supervisor and am reviewing a students code where they have used a new approach i don’t know (this happens lots that students find the latest thing that I didn’t know about). While skimming through a students code looking for why the output looks strange, if I see the words repair and temporal it will inform me about what was done. Tddr will not. I’m aware I can read the docs, but sometimes I’m rushed.

I think votes have been cast. There is no correct decision here. Someone just needs to make a decision, I’m new to MNE and don’t know the system, so will leave this to more experienced developers. I’ve appreciated the discussion though.

Read more comments on GitHub >

github_iconTop Results From Across the Web

A motion correction method for fNIRS - PubMed - NIH
Temporal Derivative Distribution Repair (TDDR): A motion correction method for fNIRS · Authors · Affiliations.
Read more >
mne.preprocessing.nirs.temporal_derivative_distribution_repair
Applies temporal derivative distribution repair (TDDR) to data [1]. This approach removes baseline shift and spike artifacts without the need ...
Read more >
DTCC Data Repository (U.S.) LLC Form SDR application
Data submitted during DDR System. Unscheduled Downtime is stored and processed once the service has resumed. Information from the queue is ...
Read more >
A motion correction method for fNIRS,NeuroImage - X-MOL
Temporal Derivative Distribution Repair (TDDR): A motion correction method for fNIRS ... 时间导数分布修复(TDDR):fNIRS 的运动校正方法
Read more >
TO 00-5-1 - Tinker Air Force Base - AF.mil
ESTABLISHING AND MANAGING TECHNICAL ORDER DISTRIBUTION OFFICES (TODO) AND ... Receipt of Formal Time Compliance Technical Orders (TCTO).
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found