ISA-tools / ISA-tools/isa-api

Add function to remove protocols declared but not used

Open
#279 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement low priority new feature
Dominant language
Python
Stars
48
Forks
42
PR merge metrics
No merged PRs in 30d

Description

This is not critical as it would be extra information in the ISA files (and the validator only gives a warning), but within the set of curation functions, we can consider adding one to remove those protocols declarations that are never used.

An example warning in this case is:

WARNING:isatools.isatab:(W) Some protocols declared in the file s_gsk_longitudinal.txt are not used in any assay file: ['', 'data transformation', 'extraction', 'labeling']

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing set of curation functions and the validator logic that reports unused protocol declarations. Trace how protocol declarations are compared with protocols used in assay files, then define the function's behavior for declarations such as those shown in the warning. Done means the unused declarations can be removed without affecting used protocols or ISA file validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.