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

Add project, data collection metadata and associated CV tables #22

Open
wants to merge 21 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
903bb6b
Add project, data collection metadata and associated CV tables
pbishwakarma Jul 19, 2023
ba470f6
updating data collection metadata table and README
patrick-lloyd-ray Sep 27, 2023
779d5cc
updating organization metadata and README
patrick-lloyd-ray Sep 27, 2023
36f40ff
updating person metadata and README
patrick-lloyd-ray Sep 27, 2023
208f9aa
updating project metadata and README
patrick-lloyd-ray Sep 27, 2023
e6dd428
updating CV csvs and readme links
patrick-lloyd-ray Sep 27, 2023
2ddc4d7
Fix subdomain and version date for entities
pbishwakarma Aug 7, 2024
677f1a4
Add explicit modeling of web resources
pbishwakarma Aug 7, 2024
83eed30
Point to web resource types in other sub domains
pbishwakarma Aug 7, 2024
28668ed
Remove accessControl code/description and clarify some descritions of…
pbishwakarma Aug 7, 2024
3f63b09
Explicitly model grants
pbishwakarma Aug 7, 2024
6703466
Update protocol data type to be WebResource
pbishwakarma Aug 7, 2024
47fc626
Update naming scheme for grant fields and add license
pbishwakarma Sep 10, 2024
946607f
Correct license reference in data collection from cv to entity
pbishwakarma Sep 10, 2024
ac89a9d
Fix reference to grant in project to be entity
pbishwakarma Sep 10, 2024
d550e0d
Fix typo in grant metadata
pbishwakarma Sep 10, 2024
5e3241d
Naming convention for grant field
pbishwakarma Sep 10, 2024
993af0f
Standardize domain for entities
pbishwakarma Sep 10, 2024
83db9d8
Standardize columns to template
pbishwakarma Sep 10, 2024
93bf71d
Fix subset and class columns
pbishwakarma Sep 10, 2024
7f7f93b
adding UUIDs for license-metadata and webresource-metadata
patrick-lloyd-ray Sep 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Proposed BICAN Field Name,BICAN UUID,Label,Variable (short) name,definition,short description,human readable label,is_required,permissible values,data type,version,version date,sub domain name,domain name,size,min value,max value,measurement type (unit)
data collection name,f7b04e21-c12d-4b3d-ba0e-b1de6ac92dca,name,,"A human-readable, locally unique label that identifies a data collection.","Human readable, locally unique identfier",,Y,,String,1,27-09-2023,Project Metadata,Projects and Data Collections,,,,
data collection long form title,62208817-6a7f-4e70-9c4a-d262f43d82cc,title,,A long form title of a data collection. ,Long form title of the collection,,Y,, String,1,27-09-2024,Project Metadata,Projects and Data Collections,,,,
data collection short form title,f5169355-52cf-4720-904f-946c92489faa,shortTitle,,A short form title of a data collection (fewer than 30 characters).,Short form title of the collection. Should be <30 characters,,Y,, String,1,27-09-2025,Project Metadata,Projects and Data Collections,<30 characters,,,
data collection description,c5188587-2b4f-4889-ae93-224efdb803d2,description,,A description of a data collection that includes a specification of the license of the data collection. ,Description of the collection. Specify license application here.,,Y,, String,1,27-09-2026,Project Metadata,Projects and Data Collections,,,,
data collection archive,39498a35-3cb5-46ce-9e23-dc5e499b85c4,dataArchive,,The location (archive) at which the data in a data collection is to be deposited. ,Archive at which data will be deposited,,Y,[Organization CV],[Organization],1,27-09-2027,Project Metadata,Projects and Data Collections,,,,
data collection species,7135fb76-5423-44da-ba52-4c33e8626033,species,,The common name of the species of the donor from which data were collected for this data collection.,Common name of species of donor from which data were collected. See species controlled vocabulary,,Y,[Species CV],[enum],1,27-09-2028,Project Metadata,Projects and Data Collections,,,,
data collection access control,3880e926-d2fb-4960-bf61-4b5789e6c027,accessControl,,The level of access specified for a data collection. ,Level of acess specified for data in collection. See accessControl controlled vocabulary,,Y,,enum,1,27-09-2029,Project Metadata,Projects and Data Collections,,,,
data collection access control code,1ff82abd-7ada-48f0-b235-6aa1b7c36f6b,accessControlCode,,The code that denotes the access restrictions specified for a data collection. ,Controlled vocabulary of codes that specify nature of access restriction. Values TBD,,N,,enum,1,27-09-2030,Project Metadata,Projects and Data Collections,,,,
data collection access control description,85b8be40-51e1-4357-af33-fa95fe7d7d68,accessControlDescription,,A free text description of the access restrictions specified for a data collection. ,Free text description of access restrictions,,N,,String,1,27-09-2031,Project Metadata,Projects and Data Collections,,,,
data collection completion state,456513f2-0af8-45e1-b8f0-338636ed3f61,completionState,,A value that specifies whether or not additional data is being generated for a data collection. ,Whether or not additional data is being generated for this collection. See completionState controlled vocabulary,,Y,,enum,1,27-09-2032,Project Metadata,Projects and Data Collections,,,,
data collection modality,480af9eb-0128-4602-9c8f-01416820cee3,modality,,The modality of the data in a data collection. ,Defines modality of the data in this collection. See modality controlled vocabulary,,Y,[Modality CV],[enum],1,27-09-2033,Project Metadata,Projects and Data Collections,,,,
data collection technique,bee3bda8-c103-448f-8557-effcaca176bf,technique,,The technique that was used to acquire the data in a collection. ,Technique used to acquire data in this collection. See technique controlled vocabulary,,Y,[Techniques CV],[enum],1,27-09-2034,Project Metadata,Projects and Data Collections,,,,
data collection license,b184e037-1b45-4ca6-8651-7044b1a74199,license,,A license that is applied to the data in a data collection. ,License applied to the data in this collection. See license controlled vocabulary,,Y,[License CV],[enum],1,27-09-2035,Project Metadata,Projects and Data Collections,,,,
data collection web resource,ebdc27a1-37ca-46ec-8914-6d3fae85a3d9,webResource,,A URL or weblink that provides the location of relevant tools or pages to a data collection. ,Links to relevant tools/pages to data collection,,N,[URL],[String],1,27-09-2036,Project Metadata,Projects and Data Collections,,,,
data collection citation,ea4729c6-df21-40db-8141-5af1d44ba75c,citation,,A data citation for a data collection. ,Auto generated data citation from collection metadata,,N,,String,1,27-09-2037,Project Metadata,Projects and Data Collections,,,,
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Proposed BICAN Field Name,BICAN UUID,Label,Variable (short) name,definition,short description,human readable label,is_required,permissible values,data type,version,version date,sub domain name,domain name,size,min value,max value,measurement type
organization name,3788d44f-8383-4707-845d-bb8289815b32,name,,"A human-readable, locally unique label that identifies a organization. ","Human readable, locally unique identifier",,Y,, String,1,27-09-2023,Organization Metadata,Projects and Data Collections,,,,
organization Research Organization Registry ID,3fd3913c-0e36-4fe0-ac99-073f496c0919,ror,,A Research Organization Registry ID that identifies an organization. ,Research Organization Registry ID,,N,, String,1,27-09-2024,Organization Metadata,Projects and Data Collections,,,,
5 changes: 5 additions & 0 deletions docs/schemas/project-registration-bican/Person-metadata.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Proposed BICAN Field Name,BICAN UUID,Label,Variable (short) name,definition,short description,human readable label,is_required,permissible values,data type,version,version date,sub domain name,domain name,size,min value,max value,measurement type
person name,da5203bf-0202-4cd0-b0c2-5cc05806e2e4,name,,"A full name of a person in [given name],[family name] format.","Full name in Given name, Family name format",,Y,,String,1,27-09-2023,Person Metadata,Projects and Data Collections Metadata,,,,
person given name,2354176f-40f2-4110-98d9-0c203314bfde,givenName,,A given name of a person. ,Given name,,Y,,String,1,27-09-2024,Person Metadata,Projects and Data Collections Metadata,,,,
person family name,f5d8f1a3-ce30-45eb-ac26-13a8998c2f5a,familyName,,A family name of a person. ,Family name,,Y,,String,1,27-09-2025,Person Metadata,Projects and Data Collections Metadata,,,,
person ORCID,e834467e-a05e-4b9f-8348-5c0079bdaac8,orcid,,An ORCID that identifies a person. ,ORCID Identifier,,N,,String,1,27-09-2026,Person Metadata,Projects and Data Collections Metadata,,,,
14 changes: 14 additions & 0 deletions docs/schemas/project-registration-bican/Project-metadata.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Proposed BICAN Field Name,BICAN UUID,Label,Variable (short) name,definition,short description,human readable label,is_required,permissible values,data type,version,version date,sub domain name,domain name,size,min value,max value,measurement type
project name,a0d7797f-aaf1-4d3e-8289-51a94237b9c8,name,,"A human readable, locally unique identifier that denotes a project. ","Human readable, locally unique identfiier",,Y,,String,1,27-09-2023,Project Metadata,Projects and Data Collections,,,,
project title,34e55bb4-17db-4b7f-bd7d-7272ffe1c9f2,title,,A long form project title.,Long form project title,,Y,,String,1,27-09-2024,Project Metadata,Projects and Data Collections,,,,
project short title,216cc403-423a-4b43-b935-b9b61dbb8a26,shortTitle,,A short form project title. ,Short form project title,,Y,,String,1,27-09-2025,Project Metadata,Projects and Data Collections,,,,
project description,c51e8c8d-d62b-4b79-843b-a3a6810fe709,description,,A long form project description. ,Long form description ,,Y,,String,1,27-09-2026,Project Metadata,Projects and Data Collections,,,,
project subprogram,cfd9d928-673a-428a-b5f0-c04e2fdd8ec9,subprogram,,A subprogram to which a project belongs. ,Subprogram to which this project belongs. See subprogram controlled vocabulary,,Y,[Subprogram CV],enum,1,27-09-2027,Project Metadata,Projects and Data Collections,,,,
project contact,62381d66-c414-4fe9-8b07-0a00ee855e71,contact,,A primary contact for a project. This is typically a person but can also be an institution. ,"Primary contact, usually a person, but can also be an institution",,N,,Person.name | Organization.name,1,27-09-2028,Project Metadata,Projects and Data Collections,,,,
project creator,34c891d4-d721-4023-bbf9-06b84f6a93cc,creator,,A creator of a project. This is either a person or institution. ,"Creator, can be person(s) or institution(s).",,Y,,[Person.name | Organization.name],1,27-09-2029,Project Metadata,Projects and Data Collections,,,,
project contributor,8a1a747c-c24d-451a-9168-ed14d274a97c,contributor,,A contributor to a project. This is often given as a list. ,List of contributors to be attributed in citation,,Y,,[Person.name],1,27-09-2030,Project Metadata,Projects and Data Collections,,,,
project funding source,3f85bc4b-2e03-426e-b376-4607fc9515e3,fundingSource,,The funding source for a project. ,See controlled vocabulary derived from grants,,Y,[Grant CV],[enum],1,27-09-2031,Project Metadata,Projects and Data Collections,,,,
project collections,66093eb6-fdaf-4782-8dba-23f6575254d8,collections,,The data collections that are part of a project.,List of data collection names,,N,[Data Collection CV],[Collection],1,27-09-2032,Project Metadata,Projects and Data Collections,,,,
project highlighted web resource,2bb2472b-73b7-426b-adb2-739924a0751b,highlightedWebResource,,A link to relevant tools/pages of a project.,"Links to relevant tools/pages to view data, can be from data collections' links",,N,,[String],1,27-09-2033,Project Metadata,Projects and Data Collections,,,,
project protocol,3e80809a-de1a-4333-98a9-f19549fda246,protocol,,A protocol for a project. ,"List of links to protocol documents, usually from protocol.io",,N,,[String],1,27-09-2034,Project Metadata,Projects and Data Collections,,,,
project publication,52d1b518-37e0-4b69-b1d8-36d1ff437376,publication,,A publication associated with a project. ,"DOI, not currently in use",,N,,String,1,27-09-2035,Project Metadata,Projects and Data Collections,,,,
Loading