Share extra info about your CFDE project

Overview

What is CFDE?

The Common Fund Data Ecosystem (CFDE) is an effort to bring together knowledge across NIH Common Fund programs into a cohesive resource.

Who are we?

The authors of this page are the Integration and Coordination Center (ICC), a center within the CFDE.

We are responsible for (among other things) gathering info associated with Common Fund projects and sharing it with the NIH. We also aim to make already-public info more accessible by presenting it in a centralized way.

We do not operate alone; we do this in close collaboration with other CFDE centers.

What is this page?

This page explains how you can share some extra info about your Common Fund project, helping the NIH have a more complete understanding of your work.

See below for exactly what this extra info is.

What do we do with this info?

We only gather info about projects and share it with the NIH. The goal of this isn't to compare across projects, it's to help program staff understand how certain activities lead to increased impact.

Who can see this info?

The extra info we gather may be considered to be sensitive by some. Because of this, we keep it private with privileged access. If you'd like to see the extra info we've gathered for your project, please contact us.

We also gather some standard info about Common Fund projects, like grant details, publications, and citations. These are already publicly available, so we do not keep them private.

See below for more details.

Is this required?

Currently no, but it may be required in the future. Being funded by the NIH, Common Fund projects may have certain reporting obligations.

For now, this is opt-in. We and the NIH won't know about this extra info if you choose not to share it.

What is the benefit?

One set of metrics can't fully represent your work, but the more you share the fuller picture you can paint.

Imagine you hold an event where you discuss your work and share public links to it. You might see a spike in your Google Analytics the week after the event. With the help of our info gathering, the NIH could see the direct impact of that immediately and conveniently.

Can't this be automatic?

Most of what we do already is. We automatically gather publicly available info through resources like iCite.

This page is about extra info that we can't gather automatically. Currently, this just means we need you to manually tag some things with your project numbers so we can associate them together.

We've tried to make this process as easy and minimal as possible. If you already know your project numbers, it should only take a few minutes.

How does it work?

All of the code we use is publicly visible in the GitHub nih-cfde/icc-eval-core repository, for transparency. For anything that is possibly sensitive, we run the exact same code that is publicly visible (we checkout the code directly from the public repo), except we store the results privately.

Here is a high-level overview of what info we gather and where we gather it from. All parts of this process are automatic, except parts marked with ✍️ which need some manual action.

      flowchart
        subgraph g2["Extra info, possibly sensitive"]
          direction TB
          n5("
            ✍️ Tag your properties with project # and grant us access
          "):::node
          n6("
            📈 Analytics
            Page views, new users, top regions, etc.
            analyticsdata.googleapis.com
          "):::node
          n7("
            ✍️ Tag your repos with project #
          "):::node
          n8("
            💽 Repos
            Stars, commits, issues, PRs, etc.
            api.github.com
          "):::node
        end
        subgraph g1["Standard info, already public, non-sensitive"]
          direction TB
          n1("
            🔬 Projects
            #/ID, activ. code, etc.
            commonfund.nih.gov
          "):::node
          n2("
            🪪 Project details
            Name, award $, dates, etc.
            api.reporter.nih.gov
          "):::node
          n3("
            📖 Publications
            Title, authors, dates, citations, etc.
            icite.od.nih.gov
            api.reporter.nih.gov
          "):::node
          n4("
            📚 Journals
            eutils.ncbi.nlm.nih.gov
            scimagojr.com
          "):::node
        end
        
        subgraph g3["Public repo"]
          direction TB
          n9("
            All gathered data
            Structured JSON
          "):::node
        end
        subgraph g4["Private repo"]
          direction TB
          n10("
            All gathered data
            Structured JSON
          "):::node
        end
        g1:::group
        g2:::group
        g3:::group
        g4:::group
        n1 --> n2
        n2 --> n3
        n3 --> n4
        n5 -->|Get properties we have access to| n6
        n7 -->|Search whole site for project # tags| n8
        g1 -->|Linked to projects with tag #s| g3
        g2 -->|Linked to projects with tag #s| g4
        classDef group color:black,stroke-width:0px,fill:aliceblue,white-space:nowrap
        classDef node color:black,stroke-width:0px,fill:#e0e8ef
        linkStyle default color:black,stroke:black
        linkStyle 6 white-space:nowrap;
    

Helper app

In an effort to make things even easier, we're working on a webapp that can help you lookup your Common Fund project and quickly perform some of the instructions below.

Helper App alpha

This is still very early in development and has limitations. You'll still have to follow the instructions below if you want to share everything. Please test it to help us make improvements.

Instructions

How to share extra info about your Common Fund project, manually.

Software repositories

Repositories ("repos") are places for storing, tracking changes to, and collaborating on software.

Currently, we only take software kept in public GitHub repos. Private repos and other platforms such as GitLab aren't supported yet.

  1. Find all GitHub repos that are associated with your project.
    1. If you're unsure where to find these, ask members of your project about any software that was written in support of it, and where the code for the software resides.
  2. "Tag" each repo with the project.
    1. See GitHub's instructions for tagging repos for reference.
    2. On the main page of the repo, click on the gear ⚙ next to "About".
    3. Under "Topics", type in your core project number, e.g. U54OD036472 (case-insensitive). Don't confuse this with a (sub) "project" number, which is longer, e.g. 1U54OD036472-01.

Analytics

Analytics are services that monitor traffic (number of visits over time, number of unique visitors, visitor demographics, etc.) on public webpages.

Currently, we only take webpages using Google Analytics. Other analytics services may be supported in the future.

  1. Find all Google Analytics properties that are associated with your project.
    1. If you're unsure where to find these, ask members of your project about any webpages related to it, and if anyone set up analytics for them.
  2. Give us read access to each property.
    1. Go to the Google Analytics dashboard and make sure you are on the right property.
    2. Find "Property Access Management" from the main search bar (or the "Admin" side menu).
    3. Add a new user with the email api-access@cfde-icc-eval-core-433116.iam.gserviceaccount.com, uncheck "Notify by email", and select the "Viewer" role.
  3. "Tag" each property so we can associate it with a particular project.
    1. Find "Key Events" from the "Admin" side menu,under "Data Display".
    2. Create a new key event with the name cfde_XXX (case-insensitive), where XXX is your core project number, e.g. cfde_U54OD036472. Don't confuse this with a (sub) "project" number, which is longer, e.g. 1U54OD036472-01.

Contact

If you have any questions, suggestions, comments, or feedback, please file a new issue, or contact one of the current maintainers/team members directly: