Skip to content

Conversation

@adamdaudrich
Copy link
Collaborator

@adamdaudrich adamdaudrich commented May 20, 2025

Brief summary of changes

  • This is a different approach to the docs; a way to more gradually introduce the complexity of the variables to the reader.
  • The Pscid.md file is an example of how this approach could be structured.
  • The CandID file is started.
  • The Identifiers.md file is not needed, I feel.
  • I was asked to correct a small typo (it's - > its) in the README.md
  • I changed the 'Introduction to Study Variables' to become a concise branching document, linking to the other files


### Overview
This page covers how to set up LORIS with basic parameters for research data.
In LORIS, and indeed in all of its instances (CBIG, CCNA, xxx, yyy, etc), the names of participants is anonymized by assigning numeric and alphanumeric ID's to them. In this way, the data of a participant is protected from connection to their name or personal identifying information ("PII").
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Preferable to not have specific project names in core LORIS (CCNA, CBIG ,...).

I would also rephrase this a bit in the style "LORIS is nto intended to store PII, Identifiers are used for data linkage"

Comment on lines 21 to 22
- Cardinality: Multiple per participant
- Data dissemination
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cardinality here is 1 per participant as well just like PSCID and DCCID

- Cardinality: One per participant per project
- Main participant identifier

- [ExteralID]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also why is there no section for externalID configuration

Comment on lines 24 to 28
- [Projects]
- [Sites]
- [Cohorts]
- [Timepoints]
- [Configurations]
Copy link
Collaborator

@ridz1208 ridz1208 May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure given the restructure why those are in the Identifiers section here

The **PSCID** is dependent on the list of sites in the `psc` table of the database, more specifically the `Alias` column that is used for the `siteAbbrev` type in the generation of the ID. Please refer to the [Sites Parameter Setup](03_Sites.md) page for more details.

The **PSCID** is also dependent on the list of projects in the `Project` table of the database, more specifically the `Alias` column that is used for the `projectAbbrev` type in the generation of the ID. Please refer to the [Projects Parameter Setup](02_Projects.md) page for more details.
I feel that this file is not needed No newline at end of file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this and delete the file isntead

[](#)


CandID is an unique numerical ID given to each participant on a per study basis. This ID is typically 6 digits long, however, recently, more digits have been added.Used internally, its principal purpose is for data relationships within the database. It is found in the following database tables:
Copy link
Collaborator

@ridz1208 ridz1208 May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its not per study, its per instance. it is also no longer 6 digits, you dont need to mention that at all the history is not relevant here. Its primary purpose is debatable. its no longer used for data linkage cause the ID column does that now. Its primary purpose is more a redundancy at this point I guess.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should mention that this one is autogenerated, not configurable

@@ -0,0 +1,75 @@
# PSCID (Project Study Center ID)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

File name shoul be all caps too be consistent with how we use it.

@@ -0,0 +1,75 @@
# PSCID (Project Study Center ID)

The PSCID is the main participant identifier in Loris. With one ID assigned to each participant per project. It serves the purposes of this this this and this.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

technically not per project but per instance, if you are thinking of CBIG, we just know there are project overlaps and have a system to merge these participants.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh and I love the purpose

Comment on lines 9 to 11
|sequential|MTL0006, MTL0007, MTL0008|Generates a static prefix with incrementing numbers|
|manual|A1, B2, Q5|Generates a fixed-length alphanumeric pattern|
|random|BUDDY29, BUDDY02, BUDDY96|Generates a static prefix followed by a random number of fixed length|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you are mixing generation type with format. i.e. sequential doesnt mean that ther eis a static prefix, thats an option the ADMIN makes, if they choose to have a static section then the config should clearly indicate it and this table doesnt because you are not showing the configuration associated with the example. I think you are better off removing this table and just relying on the content below it that explains it more clearly.

as for the "manual" part, well its manual, nothing gets generated.

minimum `min` and maximum `max` values for sequentially and randomly generated PSCIDs.
By default sequence will start at the lowest possible values (i.e.: 0000, AAAA).

## Interaction With LORIS
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why this section was completely removed from the documentation. its pretty important

@CamilleBeau
Copy link
Collaborator

As per Dave, this should be rebased to main branch

@adamdaudrich adamdaudrich changed the base branch from 27.0-release to main June 9, 2025 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants