R API client for F-UJI

F-UJI is a Service for Evaluating Research Data Objects Based on FAIRsFAIR Metrics.

This work was supported by the FAIRsFAIR project (H2020-INFRAEOSC-2018-2020 Grant Agreement 831558).

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

• API version: 1.1.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RClientCodegen

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")

Build the package

git clone https://github.com/NFDI4Chem/rfuji
cd rfuji
R CMD build .
R CMD check rfuji_1.0.0.tar.gz --no-manual
R CMD INSTALL rfuji_1.0.0.tar.gz

Install the package

install.packages("rfuji")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("GIT_USER_ID/GIT_REPO_ID")

Usage

library(rfuji)

Documentation for API Endpoints

All URIs are relative to http://localhost:1071/fuji/api/v1 or the public https://seprojects.marum.de/fuji/api/v1/openapi.json

Class	Method	HTTP request	Description
FAIRMetricApi	GetMetrics	GET /metrics	Return all metrics and their definitions
FAIRObjectApi	AssessById	POST /evaluate

Documentation for Models

• Body
• CommunityEndorsedStandard
• CommunityEndorsedStandardAllOf
• CommunityEndorsedStandardOutputInner
• CoreMetadata
• CoreMetadataAllOf
• CoreMetadataOutput
• DataAccessLevel
• DataAccessLevelAllOf
• DataAccessOutput
• DataContentMetadata
• DataContentMetadataAllOf
• DataContentMetadataOutput
• DataContentMetadataOutputInner
• DataFileFormat
• DataFileFormatAllOf
• DataFileFormatOutputInner
• DataProvenance
• DataProvenanceAllOf
• DataProvenanceOutput
• DataProvenanceOutputInner
• FAIRResultCommon
• FAIRResultCommonScore
• FAIRResultEvaluationCriterium
• FAIRResults
• FormalMetadata
• FormalMetadataAllOf
• FormalMetadataOutputInner
• IdentifierIncluded
• IdentifierIncludedAllOf
• IdentifierIncludedOutput
• IdentifierIncludedOutputInner
• License
• LicenseAllOf
• LicenseOutputInner
• MetadataPreserved
• MetadataPreservedAllOf
• MetadataPreservedOutput
• Metric
• Metrics
• OutputCoreMetadataFound
• OutputSearchMechanisms
• Persistence
• PersistenceAllOf
• PersistenceOutput
• RelatedResource
• RelatedResourceAllOf
• RelatedResourceOutputInner
• Searchable
• SearchableAllOf
• SearchableOutput
• SemanticVocabulary
• SemanticVocabularyAllOf
• SemanticVocabularyOutputInner
• StandardisedProtocolData
• StandardisedProtocolDataAllOf
• StandardisedProtocolDataOutput
• StandardisedProtocolMetadata
• StandardisedProtocolMetadataAllOf
• StandardisedProtocolMetadataOutput
• Uniqueness
• UniquenessAllOf
• UniquenessOutput

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication

Author(s)

sneumann@ipb-halle.de rhuber@uni-bremen.de anusuriya.devaraju@googlemail.com