Skip to contents

Since schema versions may change during the life cycle of project, it is important that users have access to all schema versions via this package. This function allows you to quickly retrieve whichever schema version you may need.

Usage

wdds_json(version = NULL, file = NULL)

Arguments

version

Character or NULL. Version of the wdds deposit. Leave as NULL to see all versions. Default is NULL to return character vector of versions.

file

Character or NULL. Specific file from the wdds deposit. Leave as NULL to see all files in a version. Default is NULL to return character vector of relative file paths.

Value

Character. Either version identifiers, relative file paths within a version, or a specific file path.

Details

This function does three things:

  1. Shows all versions of the schema in the package if both version and file are NULL.

  2. Provides relative paths to all schema files associated with a version of the schema if only version is provided.

  3. Provides a specific file path in a specific version of the schema if version and file path are provided.

Examples


# see which versions are in the package

wdds_json()
#> The following versions of the standard are availble in the package:
#>         -  latest
#>         -  v_1_0_0
#>         -  v_1_0_1
#>         -  v_1_0_2
#>         -  v_1_0_3
#> [1] "latest"  "v_1_0_0" "v_1_0_1" "v_1_0_2" "v_1_0_3"

# see files associated with a version

wdds_json(version = "latest")
#> [1] "schemas/datacite/datacite-v4.5.json" "schemas/disease_data.json"          
#> [3] "schemas/project_metadata.json"       "wdds_schema.json"                   

# get the file path for a specific file

wdds_json(version = "v_1_0_2", file = "schemas/disease_data.json")
#> [1] "/home/runner/work/_temp/Library/wddsWizard/extdata/wdds_archive/v_1_0_2/wdds_schema/schemas/disease_data.json"