Package: rDataPipeline 0.54.3

Sonia Mitchell

rDataPipeline: Functions to Interact with the 'FAIR Data Pipeline'

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.

Authors:Sonia Mitchell [cre, aut], Ryan Field [ctb]

rDataPipeline_0.54.3.tar.gz
rDataPipeline_0.54.3.zip(r-4.5)rDataPipeline_0.54.3.zip(r-4.4)rDataPipeline_0.54.3.zip(r-4.3)
rDataPipeline_0.54.3.tgz(r-4.4-any)rDataPipeline_0.54.3.tgz(r-4.3-any)
rDataPipeline_0.54.3.tar.gz(r-4.5-noble)rDataPipeline_0.54.3.tar.gz(r-4.4-noble)
rDataPipeline_0.54.3.tgz(r-4.4-emscripten)rDataPipeline_0.54.3.tgz(r-4.3-emscripten)
rDataPipeline.pdf |rDataPipeline.html✨
rDataPipeline/json (API)

# Install 'rDataPipeline' in R:
install.packages('rDataPipeline', repos = c('https://fairdatapipeline.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/fairdatapipeline/rdatapipeline/issues

On CRAN:

data-pipelinefair

29 exports 4 stars 1.46 score 52 dependencies 11 scripts 190 downloads

Last updated 13 days agofrom:bab526f3e2. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 05 2024
R-4.5-winOKSep 05 2024
R-4.5-linuxOKSep 05 2024
R-4.4-winOKSep 05 2024
R-4.4-macOKSep 05 2024
R-4.3-winOKSep 05 2024
R-4.3-macOKSep 05 2024

Exports:add_readadd_writecreate_configfair_initfair_runfdpfinalisefind_read_matchfind_write_matchfindmeget_componentsget_dataproductget_entryinitialiselink_readlink_writeraise_issueraise_issue_configraise_issue_reporaise_issue_scriptrandom_hashread_arrayread_distributionread_estimateread_tablewrite_arraywrite_distributionwrite_estimatewrite_table

Dependencies:askpassassertthatclicliprconfigrcrayoncredentialscurldescdplyrfansifsgenericsgertghgit2rgitcredsgluehttrhttr2inijsonlitelifecyclemagrittrmimeopensslpillarpkgconfigpurrrR6rappdirsRcppRcppTOMLrhdf5rhdf5filtersRhdf5librlangrprojrootrstudioapisemverstringistringrsystibbletidyselectusethisutf8vctrswhiskerwithryamlzip

Readme and manuals

Help Manual

Help pageTopics
rDataPipelinerDataPipeline-package rDataPipeline
add_readadd_read
add_writeadd_write
check_configcheck_config
check_dataproduct_existscheck_dataproduct_exists
check_datetimecheck_datetime
Check if entry exists in the data registrycheck_exists
check_fieldcheck_field
check_fieldscheck_fields
check_handlecheck_handle
check_integercheck_integer
check_local_repocheck_local_repo
check_stringcheck_string
Check if table existscheck_table_exists
check_yaml_writecheck_yaml_write
Clean queryclean_query
create_configcreate_config
create_indexcreate_index
Create version numbercreate_version_number
Download source file from databasedownload_from_database
Download source file from URLdownload_from_url
extract_idextract_id
fair_initfair_init
fair_runfair_run
fdp_resolve_readfdp_resolve_read
fdp_resolve_writefdp_resolve_write
fdp-classfdp fdp-class
Finalise code runfinalise
Find matching read aliases in config filefind_read_match
Find matching write aliases in config filefind_write_match
findmefindme
get_author_urlget_author_url
Get H5 file componentsget_components
get_dataproductget_dataproduct
Get entity from urlget_entity
Return all fields associated with a table entry in the data registryget_entry
Return all entries posted to a table in the data registryget_existing
Get fields from tableget_fields
Calculate hash from fileget_file_hash
Get current GitHub hashget_github_hash
Get IDget_id
get_indexget_index
get_max_versionget_max_version
Get storage location from urlget_storage_location
get_tokenget_token
Get URLget_url
increment_filenameincrement_filename
Initialise code runinitialise
Check whether fields are queryableis_queryable
Link path to external format datalink_read
Link path for external format datalink_write
Post entry to author tablenew_author
Post entry to code_repo_release tablenew_code_repo_release
Post entry to code_run tablenew_code_run
Post entry to data_product tablenew_data_product
Post entry to external_object tablenew_external_object
Post entry to file_type tablenew_file_type
Post entry to issue tablenew_issue
Post entry to keyword tablenew_keyword
Post entry to licence tablenew_licence
Post entry to namespace tablenew_namespace
Post entry to object tablenew_object
Post entry to object_component tablenew_object_component
Post entry to quality_controlled tablenew_quality_controlled
Post entry to storage_location tablenew_storage_location
Post entry to storage_root tablenew_storage_root
Post entry to user_author tablenew_user_author
Check whether paper existspaper_exists
raise_issueraise_issue
Raise issue with config fileraise_issue_config
Raise issue with remote repositoryraise_issue_repo
Raise issue with submission scriptraise_issue_script
random_hashrandom_hash
Read array component from HDF5 fileread_array
Read distribution component from TOML fileread_distribution
Read estimate component from TOML fileread_estimate
Read table component from HDF5 fileread_table
register_issue_dataproductregister_issue_dataproduct
register_issue_scriptregister_issue_script
remove_empty_parentsremove_empty_parents
resolve_readresolve_read
resolve_versionresolve_version
resolve_data_productresolve_write
Validate fieldsvalidate_fields
Write array component to HDF5 filewrite_array
Write distribution component to TOML filewrite_distribution
Write estimate component to TOML filewrite_estimate
Write table component to HDF5 filewrite_table