Skip to content

Commit ecb458a

Browse files
committed
Update docs
1 parent 33b448f commit ecb458a

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

docs/content/3tr-specific/3tr_validate_filename.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88

99
pattern <- paste0(
1010
"^[A-Z0-9]+_[A-Z0-9]+_[A-Za-z0-9-]+_",
11-
"(?:REDCAP-(?:RAW|LABEL|DICT)|CSV-RAW)_",
11+
"(?:REDCAP-(?:RAW|LABEL|DICT)|CSV-RAW|CDISC)_",
1212
"\\d{8}_",
1313
"(?:PASS|FAIL|PARTIAL|NA)-[A-Z0-9]+",
1414
"(?:_CONV-(?:OMOP|PXF|BFF)(?:-[0-9]+(?:[._][0-9]+)*)?)?",
15-
"\\.(?:csv|json)$"
15+
"\\.(?:csv|json|txt|yaml)$"
1616
)
1717

1818
args <- commandArgs(trailingOnly = TRUE)

docs/content/3tr-specific/3tr_validate_filename.pl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
my $PATTERN = qr/
1313
\A
1414
[A-Z0-9]+_[A-Z0-9]+_[A-Za-z0-9-]+_
15-
(?:REDCAP-(?:RAW|LABEL|DICT)|CSV-RAW)_
15+
(?:REDCAP-(?:RAW|LABEL|DICT)|CSV-RAW|CDISC)_
1616
\d{8}_
1717
(?:PASS|FAIL|PARTIAL|NA)-[A-Z0-9]+
1818
(?:_CONV-(?:OMOP|PXF|BFF)(?:-[0-9]+(?:[._][0-9]+)*)?)?
19-
\.(?:csv|json)
19+
\.(?:csv|json|txt|yaml)
2020
\z
2121
/x;
2222

docs/content/3tr-specific/3tr_validate_filename.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111

1212
PATTERN = re.compile(
1313
r'^[A-Z0-9]+_[A-Z0-9]+_[A-Za-z0-9-]+_'
14-
r'(?:REDCAP-(?:RAW|LABEL|DICT)|CSV-RAW)_'
14+
r'(?:REDCAP-(?:RAW|LABEL|DICT)|CSV-RAW|CDISC)_'
1515
r'\d{8}_'
1616
r'(?:PASS|FAIL|PARTIAL|NA)-[A-Z0-9]+'
1717
r'(?:_CONV-(?:OMOP|PXF|BFF)(?:-[0-9]+(?:[._][0-9]+)*)?)?'
18-
r'\.(?:csv|json)$'
18+
r'\.(?:csv|json|txt|yaml)$'
1919
)
2020

2121
def main():

docs/content/3tr-specific/pheno-clinical-data-nomenclature.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,33 @@ These guidelines define a minimal, strict, and parseable file naming convention
77
```
88

99
??? Example "Field Rules"
10-
- Allowed characters: `AZ`, `09`, and `-` inside tokens. Use `_` only as the token separator.
10+
- Allowed characters: `A-Z`, `0-9`, and `-` inside tokens. Use `_` only as the token separator.
1111
- No spaces or diacritics.
1212
- Extensions are lowercase.
1313
- `Disease` is required and is always the **second** token.
1414
- `QCStatus-QCBy` is **required** (e.g., `PASS-CNAG`).
1515

1616
## Components
1717

18-
1. **[Project]** Consortium or project code (e.g., `3TR`, `PRECISESADS`, `BRAMS`).
19-
2. **[Disease]** Disease acronym (e.g., `MS`, `IBD`, `UC`).
20-
3. **[StudyID]** Unique study identifier (e.g., `Study123`, `CohortA`).
21-
4. **[Source]** Data origin/type (see controlled list below).
22-
5. **[Date|Version]** Either:
18+
1. **[Project]** - Consortium or project code (e.g., `3TR`, `PRECISESADS`).
19+
2. **[Disease]** - Disease acronym (e.g., `MS`, `IBD`, `UC`).
20+
3. **[StudyID]** - Unique study identifier (e.g., `Study123`, `CohortA`).
21+
4. **[Source]** - Data origin/type (see controlled list below).
22+
5. **[Date|Version]** - Either:
2323
- Date: `YYYYMMDD`, or
2424
- Version: `vN` or `vN.N.N`.
25-
6. **[QCStatus]-[QCBy]** Required pair:
25+
6. **[QCStatus]-[QCBy]** - Required pair:
2626
- `QCStatus` in `{PASS, FAIL, PARTIAL, NA}`.
2727
- `QCBy` is the center code performing QC (e.g., `CNAG`, `KI`, `FPS`).
28-
7. **_CONV-Target[-SchemaVer]** Optional conversion info:
28+
7. **_CONV-Target[-SchemaVer]** - Optional conversion info:
2929
- `Target` in `{OMOP, PXF, BFF}`.
3030
- Optional `SchemaVer` (e.g., `5_4`, `2.0`).
31-
8. **.ext** File extension: `.csv`, `.json` (extend cautiously as needed).
31+
8. **.ext** - File extension: `.csv`, `.json`, `.txt` and `yaml` (extend cautiously as needed).
3232

3333
??? Example "Controlled Vocabularies"
3434

3535
- **Source**:
36-
`REDCAP-RAW` (raw export), `REDCAP-LABEL` (labeled export), `REDCAP-DICT` (data dictionary), `CSV-RAW` (free-form CSV)
36+
`REDCAP-RAW` (raw export), `REDCAP-LABEL` (labeled export), `REDCAP-DICT` (data dictionary), `CSV-RAW` (free-form CSV), `CDISC` (export)
3737

3838
- **QCStatus**:
3939
`PASS`, `FAIL`, `PARTIAL`, `NA`
@@ -73,7 +73,7 @@ PRECISESADS_IBD_Study123_CSV-RAW_v1.1.0_PARTIAL-FPS.csv
7373
Use this to lint filenames. Adjust only if you extend vocabularies.
7474

7575
```
76-
^[A-Z0-9]+_[A-Z0-9]+_[A-Za-z0-9-]+_(?:REDCAP-(?:RAW|LABEL|DICT)|CSV-RAW)_\d{8}_(?:PASS|FAIL|PARTIAL|NA)-[A-Z0-9]+(?:_CONV-(?:OMOP|PXF|BFF)(?:-[0-9]+(?:[._][0-9]+)*)?)?\.(?:csv|json)$
76+
^[A-Z0-9]+_[A-Z0-9]+_[A-Za-z0-9-]+_(?:REDCAP-(?:RAW|LABEL|DICT)|CSV-RAW|CDISC)_\d{8}_(?:PASS|FAIL|PARTIAL|NA)-[A-Z0-9]+(?:_CONV-(?:OMOP|PXF|BFF)(?:-[0-9]+(?:[._][0-9]+)*)?)?\.(?:csv|json|txt|yaml)$
7777
```
7878

7979
## CLI Linter Scripts

0 commit comments

Comments
 (0)