search

cessda / cessda.metadata.profiles

Contains DDI Profiles that are used by the CESSDA Metadata Validator Tool
Other
0 stars 0 forks source link

CDC 2.5 next profile: funding information #65

Closed cessda-bitbucket-importer closed 1 year ago

cessda-bitbucket-importer commented 2 years ago

Original report on BitBucket by Taina Jääskeläinen.

Carsten said the next version profiles should have grant number and funder information for OpenAire.

Consulted Katja on where this information could live in DDI 2.5. She said:

Do you agree, Darren?

‌

For CDC, minimum information on funders is enough. OpenAire has further requirements.

cessda-bitbucket-importer commented 2 years ago

Original comment by Mari Kleemola (GitHub: mari-k).

See also OpenAIRE requirements: https://guidelines.openaire.eu/en/latest/data/field_contributor.html from where the following is copy-pasted:

The syntax is:

info:eu-repo/grantAgreement/Funder/FundingProgram/ProjectID/
[Jurisdiction]/[ProjectName]/[ProjectAcronym]

where:

For OpenAIRE compatibility, the elements in square brackets are optional. The three-part namespace is mandatory when applicable (info:eu-repo/grantAgreement/Funder/FundingProgram/ProjectID), while the six-parts namespace is recommended.

cessda-bitbucket-importer commented 2 years ago

Original comment by Katja Moilanen.

Example from: https://guidelines.openaire.eu/en/latest/data/use_of_datacite.html#fundinginfo

European Commission info:eu-repo/grantAgreement/EC/FP7/282896 There is no need to have an element / attribute for each of these fields individually. Instead there is need to have a field that may have this kind of information with this specific syntax. It seems that there is no exactly correct field in DDI-C for this kind of information \(“nameIdentifier”\), but quite likely workaround is needed. DDI-C has also element //prodStmt/fundAg which has e.g. attribute abbr for abbreviation but not a place e.g. for the grant number. It might be possible to use grantNo field for this “nameIdentifier”. The start of the nameIdentifier is always the same \(needs to be checked if this true\) “`info:eu-repo/grantAgreement/`“ so it could be added by the aggregator? If we forget the not mandatory parts, then the grantNo element could include the mandatory parts: EC/FP7/282896 ? This is just a first trial, so changes may be needed. ‌
cessda-bitbucket-importer commented 2 years ago

Original comment by Taina Jääskeläinen.

Funding information should be ‘Optional’ since not all research have specific funders.

cessda-bitbucket-importer commented 2 years ago

Original comment by Darren Bell (GitHub: darrenbell2).

I’m happy to insert grantNo as a new element but note that both “@‌agency” and “@‌role” are mandatory attributes of grantNo.

The CMM contains the following guidance:

‌

@‌TainaFSD @‌KatjaMoilanen
Could you please specify what usage note you would like to accompany:

  1. grantNo element (Optional)
  2. agency attribute (Mandatory if parent present)
  3. role attribute (Mandatory if parent present)

I am guessing that there is no CDC UI label as this is for OpenAire

Thanks, Darren

@‌Hilde Orten @MortenSikt fyi

cessda-bitbucket-importer commented 2 years ago

Original comment by Katja Moilanen.

@darrenbell2 could you please explain, why @‌agency and @‌role must be mandatory?

If I checked correctly, @‌agency (AgencyOrganizationReference) and @‌role (FunderRole) are not mandatory in DDI-C (DDI-L). In DDI-C, there is only text in the description of the grantNo element “If more than one, indicate the appropriate agency using the "agency" attribute. If different funding agencies sponsored different stages of the production process, use the "role" attribute to distinguish the grant numbers.”.

I agree that it would be wise to have @‌agency as a mandatory attribute. If @‌role is mandatory, it is quite likely that a new vocabulary is needed.

cessda-bitbucket-importer commented 2 years ago

Original comment by Darren Bell (GitHub: darrenbell2).

@‌KatjaMoilanen Sorry, my mistake - I misread the XSD schema file: agency and role are both indeed optional. Can you let me know if the following is OK? Thanks, Darren: 

<!--****************************************************************************************-->
<!--FUNDING INFORMATION-->
<!--****************************************************************************************-->
<pr:Used xpath="/codeBook/stdyDscr/citation/prodStmt/grantNo" isRequired="false">
    <r:Description>
        <r:Content>Required: Optional</r:Content>
        <r:Content>ElementType: Content element</r:Content>
        <r:Content>ElementRepeatable: Yes</r:Content>
        <r:Content>Usage: The identification code of the grant or other monetary award which provided funding for the Study.
            Required for OpenAire.  Indicate the appropriate agency using the "@&zwnj;agency" attribute.
            If different funding agencies sponsored different stages of the production process, 
            use the "@&zwnj;role" attribute to distinguish the grant numbers.</r:Content>
    </r:Description>
    <pr:Instructions>
        <r:Content><![CDATA[
        <Constraints>
            <OptionalNodeConstraint/>
        </Constraints>
        ]]></r:Content>
    </pr:Instructions>
</pr:Used>
<pr:Used xpath="/codeBook/stdyDscr/citation/prodStmt/grantNo/@&zwnj;agency" isRequired="false">
    <r:Description>
        <r:Content>Required: Mandatory if 'grantNo' element is present</r:Content>
        <r:Content>ElementType: Attribute</r:Content>
        <r:Content>Usage: Agency which provided the funding.</r:Content>
    </r:Description>
    <pr:Instructions>
        <r:Content>
            <![CDATA[
            <Constraints>
                <MandatoryNodeIfParentPresentConstraint/>
            </Constraints>
            ]]>
        </r:Content>
    </pr:Instructions>
</pr:Used> 
<pr:Used xpath="/codeBook/stdyDscr/citation/prodStmt/grantNo/@&zwnj;role" isRequired="false">
    <r:Description>
        <r:Content>Required: Optional/r:Content>
        <r:Content>ElementType: Attribute</r:Content>
        <r:Content>Usage: If different funding agencies sponsored different stages of the production process, 
            use the "@&zwnj;role" attribute to distinguish the grant numbers.</r:Content>
    </r:Description>
    <pr:Instructions>
        <r:Content><![CDATA[
        <Constraints>
            <OptionalNodeConstraint/>
        </Constraints>
        ]]></r:Content>
    </pr:Instructions>
</pr:Used>

‌

cessda-bitbucket-importer commented 2 years ago

Original comment by Katja Moilanen.

I checked this issue with @‌TainaFSD .
Suggestion how to change the text of the grantNo element Usage

…. Usage: The identification code of the grant or other monetary award which provided funding for the Study. ~~Required for OpenAire.~~ If you know that the funder is included in the OpenAire list of Funders, see the instructions for grantNo syntax here: [https://guidelines.openaire.eu/en/latest/data/field\_contributor.html#nameidentifier-ma-o](https://guidelines.openaire.eu/en/latest/data/field_contributor.html#nameidentifier-ma-o) . Indicate the appropriate agency using the "@‌agency" attribute. If different funding agencies sponsored different stages of the production process, use the "@‌role" attribute to distinguish the grant numbers. …..
cessda-bitbucket-importer commented 2 years ago

Original comment by Darren Bell (GitHub: darrenbell2).

Following implemented in cdc25_profile.xml; cdc25_profile_mono.xml; cdc_122_profile.xml; cdc_122_profile_mono.xml

<!--****************************************************************************************-->
<!--FUNDING INFORMATION-->
<!--****************************************************************************************-->
<pr:Used xpath="/codeBook/stdyDscr/citation/prodStmt/grantNo" isRequired="false">
    <r:Description>
        <r:Content>Required: Optional</r:Content>
        <r:Content>ElementType: Content element</r:Content>
        <r:Content>ElementRepeatable: Yes</r:Content>
        <r:Content>Usage: The identification code of the grant or other monetary award which provided funding for the Study.
            Required for OpenAire. If you know that the funder is included in the OpenAire list of Funders,
            see the instructions for grantNo syntax here: 
            <https://guidelines.openaire.eu/en/latest/data/field_contributor.html#nameidentifier-ma-o> .
            Indicate the appropriate agency using the "@&zwnj;agency" attribute.
            If different funding agencies sponsored different stages of the production process,
            use the "@&zwnj;role" attribute to distinguish the grant numbers.</r:Content>
    </r:Description>
    <pr:Instructions>
        <r:Content><![CDATA[
        <Constraints>
            <OptionalNodeConstraint/>
        </Constraints>
        ]]></r:Content>
    </pr:Instructions>
</pr:Used>
<pr:Used xpath="/codeBook/stdyDscr/citation/prodStmt/grantNo/@&zwnj;agency" isRequired="false">
    <r:Description>
        <r:Content>Required: Optional</r:Content>
        <r:Content>ElementType: Attribute</r:Content>
        <r:Content>Usage: Agency which provided the funding.</r:Content>
    </r:Description>
    <pr:Instructions>
        <r:Content><![CDATA[
        <Constraints>
            <OptionalNodeConstraint/>
        </Constraints>
        ]]></r:Content>
    </pr:Instructions>
</pr:Used> 
<pr:Used xpath="/codeBook/stdyDscr/citation/prodStmt/grantNo/@&zwnj;role" isRequired="false">
    <r:Description>
        <r:Content>Required: Mandatory if 'grantNo' element is present</r:Content>
        <r:Content>ElementType: Attribute</r:Content>
        <r:Content>Usage: If different funding agencies sponsored different stages of the production process, 
            use the "@&zwnj;role" attribute to distinguish the grant numbers.</r:Content>
    </r:Description>
    <pr:Instructions>
        <r:Content><![CDATA[
        <Constraints>
            <OptionalNodeConstraint/>
        </Constraints>
        ]]></r:Content>
    </pr:Instructions>
</pr:Used>

‌

cessda-bitbucket-importer commented 2 years ago

Original comment by Darren Bell (GitHub: darrenbell2).

@‌KatjaMoilanen I’ve inserted this into the codebook profiles. Should this also go into the CDC3.2 profile?
Based on the CMM, the following seem to be appropriate:
1.1.6.2 - ddi:DDIInstance/s:StudyUnit/r:FundingInformation/GrantNumber
1.1.6.3 - ddi:DDIInstance/s:StudyUnit/r:FundingInformation/Description

Thanks, Darren

‌

cessda-bitbucket-importer commented 2 years ago

Original comment by Taina Jääskeläinen.

Notes:

Yes, it should go into the CDC3.2.

‌

cessda-bitbucket-importer commented 2 years ago

Original comment by Katja Moilanen.

Here is the mapping between DDI2.5 and DDI3.2

DDI2.5 //grantNo/@‌agency -- DDI3.2 //r:FundingInformation/r:AgencyOrganizationReference + (r:URN or/and (r:Agency and r:ID and r:Version)) + r:TypeOfObject
DDI2.5 //grantNo/@‌role -- DDI3.2 //r:FundingInformation/r:FunderRole
DDI2.5 //grantNo -- DDI3.2 //r:FundingInformation/r:GrantNumber

‌

cessda-bitbucket-importer commented 2 years ago

Original comment by Katja Moilanen.

Taina also noted, that language attribute is useful for DDI files with multiple languages. DDI2.5 has //grantNo/@‌xml:lang but there seems to be no xml:lang in DDI3.2 for funding information.

cessda-bitbucket-importer commented 2 years ago

Original comment by Darren Bell (GitHub: darrenbell2).

In summary, this is what I have now implemented in the different profiles:

NOTE - I HAVE NOT INCLUDED LANGUAGE INFORMATION AS THERE IS NO ALIGNMENT HERE BETWEEN 2.5 and 3.2

‌

cessda-bitbucket-importer commented 2 years ago

Original comment by Darren Bell (GitHub: darrenbell2).

fixed issue #65

cessda-bitbucket-importer commented 2 years ago

Original comment by Darren Bell (GitHub: darrenbell2).

@‌KatjaMoilanen @‌TainaFSD could you please confirm that this can be closed? Thanks, Darren

cessda-bitbucket-importer commented 2 years ago

Original comment by Darren Bell (GitHub: darrenbell2).

Correction to earlier comment:

In summary, this is what I have now implemented in the different profiles:

NOTE - I HAVE NOT INCLUDED LANGUAGE INFORMATION AS THERE IS NO ALIGNMENT HERE BETWEEN 2.5 and 3.2

cessda-bitbucket-importer commented 2 years ago

Original comment by Darren Bell (GitHub: darrenbell2).

fixed issue #65

cessda-bitbucket-importer commented 2 years ago

Original comment by Katja Moilanen.

@darrenbell2 If I was looking at the correct version of the profile, the attribute role (DDI-C) was still “Mandatory if ‘grantNo' is present’:

<pr:Used xpath="/codeBook/stdyDscr/citation/prodStmt/grantNo/@&zwnj;role" isRequired="false">
        <r:Description>
            <r:Content>Required: Mandatory if 'grantNo' element is present</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: If different funding agencies sponsored different stages of the production process, 
                use the "@&zwnj;role" attribute to distinguish the grant numbers.</r:Content>
        </r:Description>

‌

cessda-bitbucket-importer commented 2 years ago

Original comment by Katja Moilanen.

@‌TainaFSD do you know if there is already suitable vocabulary for the role attribute or will it just be used as free text field?

cessda-bitbucket-importer commented 2 years ago

Original comment by Taina Jääskeläinen.

No suitable vocabulary. DDI CV Group could draw up a vocabulary for types of funder, if needed, that should be possible.

But if it is about what kind of a role the funder has had, the situations are too varied for a controlled vocabulary. Or if it is the same role: financial contribution for two funders, the role attribute would not be useful for differentiating the two. But this might also apply to types of funders, e.g. if both are private foundations.

An easy, pragmatic solution might be to instruct people just to enter into the role attribute: ‘Funder 1’, ‘Funder 2’,' Funder 3' etc. since it is an attribute and perhaps should not contain long texts.

cessda-bitbucket-importer commented 1 year ago

Original comment by Darren Bell (GitHub: darrenbell2).

Corrections need as /codeBook/stdyDscr/citation/prodStmt/grantNo/@‌role still marked as "Mandatory if parent present" cf. Katja's comment 22/08/22

cessda-bitbucket-importer commented 1 year ago

Original comment by Darren Bell (GitHub: darrenbell2).

cdc25_profile.xml, cdc25_profile_mono.xml, cdc122_profile.xml, cdc122_profile_mono.xml:

cdc32_profile.xml:

Committed to mdo_d6 branch

‌

cessda-bitbucket-importer commented 1 year ago

Original comment by Darren Bell (GitHub: darrenbell2).

Committed to mdo_d6 branch (commit note says issue 64 which is wrong)