This validator checks whether a data repository is documented according to the
psych-ds metadata standard. It's built to work as a website, a command-line application, or an
Using the validator
Running the validator from your browser is the easiest way to get started. Please head over to our online validator and drag your data folder onto the blue zone.
RStudio, please then select
Install Packages ... from the
Tools menu. Next, please choose
Package Archive File in the
Install from dropdown, and select the file you downloaded in the last step. After confirming your selection, the installation should proceed automatically.
Alternatively, you can install the package directly from the
R command line by running the command
install.packages("https://github.com/psych-ds/validator-prototype/releases/download/v0.1.0-alpha/psychds_0.1.0.tar.gz", repos=NULL, method="libcurl").
After installing the
psychds package, you can then validate a data folder:
For example, you might want to validate your project directory with the following command:
The project consists of several different parts that work together.
validator-coredirectory contains the main validation logic that is used throughout the project.
- You'll find the web validator interface in the
validator-rdirectory holds the project
validator-nodefolder is for the node-based command-line interface
To build the project, you'll need a local installation of the
yarn package manager. With both of these in place, please run the
yarn command in the project directory to download and install all dependencies (there will be a few warnings about unmet peer dependencies, you can safely ignore these).
yarn v2 does not play nicely with the code; as of March 10 2020 please make sure to install/downgrade to
yarn v1 before attempting build.
If you would like to build the web interface, you can run the command
yarn build:web, which will collect all files necessary to host the web interface in the
validator-web/build directory. You can upload these to a web server of your choice, from which you will then be able to access the validator interface.
For development, it can be convenient to start a local server with the interface running on it. The command
(cd validator-web && yarn start) will accomplish this.
- For package development, we recommend using
RStudioand its built-in package management tools. To do so, please first run
yarn setup:rin the repository root directory to build and copy the validator core into the
Rpackage folder. You can then open the
psychds.Rprojproject file from the
RStudio, and use its package development features.
- Alternatively, you can run
yarn build:coreand any the following commands from the root directory to check, build and install the package directly: