Dataverse Plugin

We are implementing this plugin for OPS and OJS 3.3 (or higher) for SciELO Brasil.

It is a work in progress, the current version is a MVP for OPS and OJS.

Compatibility

The latest release of this plugin is compatible with the following PKP applications:

• OPS 3.4.0
• OJS 3.4.0

Using PHP 8.1 or later.

Plugin Download

To download the plugin, go to the Releases page and download the tar.gz package of the latest release compatible with your website.

Installation

Instructions

1. Install the plugin dependencies.
2. Enter the administration area of ​​your application and navigate to Settings> Website> Plugins> Upload a new plugin.
3. Under Upload file select the file dataverse.tar.gz.
4. Click Save and the plugin will be installed on your website.

Instructions for use

Configuration

After installation, it is necessary to enable the plugin. This is done in Website Settings > Plugins > Installed Plugins.

With the plugin enabled, you should expand its options by clicking the arrow next to its name and then accessing its Settings.

In the new window, the Dataverse (Dataverse URL), API Token and Terms of Use will be displayed.

You have to indicate the full Dataverse URL repository where the research data will be deposited, for example: https://demo.dataverse.org/dataverse/anotherdemo

The Terms of Use can be defined for each language configurated in your application. If you have questions about what they are, consult those responsible for the repository.

Important: The API Token belongs to a Dataverse user account. For more information on how to obtain the API token, see the Dataverse User Guide.

It is important to mention that the Dataverse user account will be included in the list of contributors of the datasets deposited by the plugin (for more information, see this discussion).

Therefore, we recommend the creation of a specific user for the journal/preprint server, instead of using a person's personal account, because each deposit will be associated with that account.

After filling in the fields, just confirm the action by clicking Save. The plugin will only work after filling in these data.

Use

A "Research Data" deposit dialog is shown in the "Files" step of the Submission proccess.

Authors, moderators, editors or managers can also edit the dataset, before publication, on the Research Data tab of the submission.

In OJS, reviewers can have access to research data files during the review process. Reviewers access to these files can be restricted on Workflow Settings, so they can only see research data when they agree to review the submission.

Development Instructions:

1. Clone the Dataverse plugin repository
2. To use the plugin into the PKP Application, copy it's folder to the /plugins/generic directory and make sure the folder is called "dataverse".
3. And from the root of the PKP Appplication directory, execute this command to update the database, creating the tables used by the plugin:
   • php tools/upgrade.php upgrade

Running Tests

Unit Tests

To execute the unit tests, run the following command from root of the PKP Appplication directory:

find plugins/generic/dataverse -name tests -type d -exec php lib/pkp/lib/vendor/phpunit/phpunit/phpunit --configuration lib/pkp/tests/phpunit-env2.xml -v "{}" ";"

Integration Tests

Creates a cypress.env.json file in root of the PKP Application directory, with the following environment variables:

• baseUrl
• dataverseUrl
• dataverseApiToken
• dataverseTermsOfUse

Example:

{
    "baseUrl": "http://localhost:8000",
    "dataverseUrl": "https://demo.dataverse.org/dataverse/myDataverseAlias",
    "dataverseApiToken": "abcd-abcd-abcd-abcd-abcdefghijkl",
    "dataverseTermsOfUse": "https://dataverse.org/best-practices/harvard-dataverse-general-terms-use"
}

Next, to execute the Cypress tests run the following command from root of the PKP Appplication directory:

npx cypress run --config specPattern=plugins/generic/dataverse/cypress/tests

For execute the tests with the Cypress UI, run:

npx cypress open --config specPattern=plugins/generic/dataverse/cypress/tests

Important: Cypress search for elements with expected strings. The locale of your operating system and PKP Application must be en for passing into the tests.

License

This plugin is licensed under the GNU General Public License v3.0

Copyright (c) 2021-2024 Lepidus Tecnologia

Copyright (c) 2021-2024 SciELO