Learn R Programming

rDataPipeline (version 0.60.0)

Functions to Interact with the 'FAIR Data Pipeline'

Description

R implementation of the 'FAIR Data Pipeline API'. The 'FAIR Data Pipeline' is intended to enable tracking of provenance of FAIR (findable, accessible and interoperable) data used in epidemiological modelling.

Copy Link

Version

Install

install.packages('rDataPipeline')

Monthly Downloads

197

Version

0.60.0

License

GPL (>= 3)

Issues

Pull Requests

Stars

Forks

Maintainer

Ryan Field

Last Published

October 8th, 2024

Functions in rDataPipeline (0.60.0)

fdp_resolve_read

fdp_resolve_read
create_config

create_config
fair_run

fair_run
fdp_resolve_write

fdp_resolve_write
fair_init

fair_init
findme

findme
create_index

create_index
find_write_match

Find matching write aliases in config file
fdp-class

fdp-class
get_components

Get H5 file components
finalise

Finalise code run
get_author_url

get_author_url
create_version_number

Create version number
find_read_match

Find matching read aliases in config file
get_entity

Get entity from url
get_fields

Get fields from table
check_string

check_string
initialise

Initialise code run
get_file_hash

Calculate hash from file
check_local_repo

check_local_repo
get_dataproduct

get_dataproduct
new_file_type

Post entry to file_type table
get_token

get_token
get_tables

Get tables from registry
get_table_queryable

Get queryable fields
increment_filename

increment_filename
get_table_readable

Get readable fields
get_storage_location

Get storage location from url
get_entry

Return all fields associated with a table entry in the data registry
get_table_optional

Get optional fields
new_keyword

Post entry to keyword table
get_index

get_index
get_url

Get URL
github_files

List files in GitHub repository
get_github_hash

Get current GitHub hash
new_storage_location

Post entry to storage_location table
get_max_version

get_max_version
new_licence

Post entry to licence table
new_issue

Post entry to issue table
get_id

Get ID
link_read

Link path to external format data
new_object

Post entry to object table
remove_empty_parents

remove_empty_parents
new_namespace

Post entry to namespace table
is_queryable

Check whether fields are queryable
read_array

Read array component from HDF5 file
raise_issue_repo

Raise issue with remote repository
raise_issue_config

Raise issue with config file
new_storage_root

Post entry to storage_root table
write_distribution

Write distribution component to TOML file
raise_issue_script

Raise issue with submission script
random_hash

random_hash
get_existing

Return all entries posted to a table in the data registry
read_distribution

Read distribution component from TOML file
write_estimate

Write estimate component to TOML file
link_write

Link path for external format data
get_table_required

Get required fields
write_table

Write table component to HDF5 file
resolve_read

resolve_read
validate_fields

Validate fields
rDataPipeline-package

rDataPipeline
raise_issue

raise_issue
get_table_writable

Get writable fields
register_issue_dataproduct

register_issue_dataproduct
new_author

Post entry to author table
new_user_author

Post entry to user_author table
register_issue_script

register_issue_script
new_object_component

Post entry to object_component table
paper_exists

Check whether paper exists
new_code_run

Post entry to code_run table
new_quality_controlled

Post entry to quality_controlled table
new_data_product

Post entry to data_product table
write_array

Write array component to HDF5 file
new_external_object

Post entry to external_object table
patch_data

Patch entry in data registry
new_code_repo_release

Post entry to code_repo_release table
read_table

Read table component from HDF5 file
post_data

Post entry to data registry
read_estimate

Read estimate component from TOML file
resolve_version

resolve_version
resolve_write

resolve_data_product
add_write

add_write
check_dataproduct_exists

check_dataproduct_exists
add_read

add_read
check_integer

check_integer
check_fields

check_fields
check_datetime

check_datetime
check_handle

check_handle
clean_query

Clean query
extract_id

extract_id
check_field

check_field
check_config

check_config
check_exists

Check if entry exists in the data registry
check_table_exists

Check if table exists
check_yaml_write

check_yaml_write
download_from_database

Download source file from database
download_from_url

Download source file from URL