inst/doc/rfair.R

In rfair: Assess the FAIRness of Research Data Objects and Software

## ----include = FALSE----------------------------------------------------------
knitr::opts_chunk$set(collapse = TRUE, comment = "#>", eval = FALSE)

## -----------------------------------------------------------------------------
# library(rfair)

## -----------------------------------------------------------------------------
# a <- assess_fair("https://doi.org/10.5281/zenodo.8347772")
# a

## -----------------------------------------------------------------------------
# as.data.frame(a)

## -----------------------------------------------------------------------------
# summary(a)

## -----------------------------------------------------------------------------
# # A license being *present* does not mean the data is open for reuse.
# a$reuse                    # per-license: open / restrictive, commercial, derivatives
# 
# # Restricted access can be legitimate (e.g. sensitive human data) and should not
# # be read as "not FAIR".
# a$access                   # access level, controlled_access, sensitive
# 
# # Identifiers should follow best practices.
# a$identifier_hygiene       # layered / non-persistent identifier warnings

## -----------------------------------------------------------------------------
# license_reuse("https://creativecommons.org/licenses/by-nc-nd/4.0/")
# identifier_hygiene("RRID:MGI:5577054")
# fair_principles()          # canonical FAIR principle definitions

## -----------------------------------------------------------------------------
# as_fuji_json(a)            # F-UJI-compatible FAIRResults JSON
# as_rdf(a)                  # W3C DQV + schema.org Rating (JSON-LD)

## -----------------------------------------------------------------------------
# launch_rfair()             # Shiny app