Time: 09:30 – 12:30
Room: TBD
Chairs: Gretchen Gueguen (Center for Open Science), Futa Ikeda (Center for Open Science)
Code: W09

The Open Science Framework (OSF) is a platform that supports the research process through data repository services, scientific study registration, and preprint publishing. This workshop will feature a hands-on tutorial on creating queries for the new OSF Search API and parsing results.  With the new API users can extract useful information to glean valuable insights into research activities on OSF. Two types of OSF Search API queries will be taught and attendees will be able to form their own queries using the Search API parameters. Typical use cases will be reviewed and attendees will be able to practice queries using the live API during the session. By the end of this workshop data librarians, repository managers, research support staff and repository developers will be able to use the OSF Search API to gather data for reports or other applications.

Audience

Data librarians, repository managers, research support staff and repository developers.

Content

The Open Science Framework (OSF) is a platform that supports the research process through data repository services, scientific study registration, and preprint publishing. It represents the full lifecycle of the research process from formulation of projects, through data collection, analysis, and sharing.

This workshop will cover use of the new OSF search API launched in 2023 as part of the suite of API tools available for the platform. With the new API users can extract useful information to glean valuable insights into research activities on OSF. Relationships  between users, their projects, data, and publications discovered through an OSF search can reveal network effects in scholarly work increasing transparency and openness. Insights revealed through this process can also help guide research support staff in developing programs, outreach, instruction, or other infrastructure for their community.

The OSF Search API takes advantage of the OSF Metadata Application Profile, which is based on the widely used Datacite Metadata Schema. This standard data format can be easily combined with data from other sources to provide an even more comprehensive look at the research activity of a particular field or institution. The data from an OSF Search API query can be used to enhance the institution’s understanding of its research population.

This workshop will feature a hands-on tutorial on creating queries for the Search API and parsing results. In order to be useful to non-developers, the session will start with some basics to get ready to work with APIs (necessary tools, basic understanding of standards used) in general.

Workshop presenters will then review how the OSF Search API works. The two types of OSF Search API queries will be demonstrated: to find objects themselves, or to search indices of values to formulate queries with. The parameters of the API search will be explained and a typical response will be reviewed. Examples of use cases and applications of the data will be discussed.

Participants will go through a shared hands-on query together, and then will have time to practice with their own queries or suggested ones. Examples of the types of queries that may be used include:

  • Find projects/registrations with open data for possible collaborators using Orcid IDs
  • Find projects funded by a specific organization
  • Find all objects associated with a particular institution
  • Find all projects with files of a certain type (datasets or software as examples)

By the end of this workshop data librarians, repository managers, research support staff and repository developers will be able to form their own queries of the OSF Search API to gather data for reports or other applications.

Learning outcomes

By the end of this workshop data librarians, repository managers, research support staff and repository developers will be able to form their own queries of the OSF to gather data for reports or other applications. This can also help teams or organizations that are developing or modifying their own discovery tools or considering an integrated tool environment to understand a model of how such an implementation works.

Requirements

Attendees will need a laptop. Software will be discussed at the beginning of the session and will be a freely available open source application.


Back to Workshops and tutorials