Package: dmdScheme 1.3.5

Rainer M. Krug

dmdScheme: Domain Specific MetaData Scheme

Forms the core for developing own domain specific metadata schemes. It contains the basic functionality needed for all metadata schemes based on the 'dmdScheme'. See R.M. Krug and O.L. Petchey (2019) <doi:10.5281/zenodo.3581970>.

Authors:Rainer M. Krug [aut, cre], Owen L. Petchey [ctb]

dmdScheme_1.3.5.tar.gz
dmdScheme_1.3.5.zip(r-4.5)dmdScheme_1.3.5.zip(r-4.4)dmdScheme_1.3.5.zip(r-4.3)
dmdScheme_1.3.5.tgz(r-4.4-any)dmdScheme_1.3.5.tgz(r-4.3-any)
dmdScheme_1.3.5.tar.gz(r-4.5-noble)dmdScheme_1.3.5.tar.gz(r-4.4-noble)
dmdScheme_1.3.5.tgz(r-4.4-emscripten)dmdScheme_1.3.5.tgz(r-4.3-emscripten)
dmdScheme.pdf |dmdScheme.html✨
dmdScheme/json (API)

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

Peer review:

Bug tracker:https://github.com/uzh-peg/dmdscheme/issues

On CRAN:

metadata-scheme

51 exports 2 stars 0.49 score 45 dependencies 15 scripts 103 downloads

Last updated 2 years agofrom:7441e6fbc8. Checks:OK: 1 NOTE: 6. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 18 2024
R-4.5-winNOTESep 18 2024
R-4.5-linuxNOTESep 18 2024
R-4.4-winNOTESep 18 2024
R-4.4-macNOTESep 18 2024
R-4.3-winNOTESep 18 2024
R-4.3-macNOTESep 18 2024

Exports:as_dmdSchemeas_dmdScheme_rawas_emlas_xmlas_xml_listcachedmdSchemedmdScheme_exampledmdScheme_rawformat_dmdScheme_xlsxlookup_tokensmake_examplemake_indexmake_new_packagenew_dmdScheme_validationopen_new_spreadsheetread_excelread_excel_rawread_xmlreportrun_appscheme_activescheme_defaultscheme_downloadscheme_installscheme_install_r_packagescheme_installedscheme_listscheme_list_in_reposcheme_makescheme_path_index_templatescheme_path_xlsxscheme_path_xmlscheme_reposcheme_uninstallscheme_usetoTransposeupgrade_old_filesvalErr_extractvalErr_infovalErr_isOKvalErr_TextErrColvalidatevalidateAllowedValuesvalidateDataFileMetaDataDataFileExistsvalidateIDFieldvalidateStructurevalidateSuggestedValuesvalidateTypeswrite_excelwrite_xml

Dependencies:base64encbslibcachemcellrangerclicpp11crayondigestevaluatefansifastmapfontawesomefsgluehighrhmshtmltoolsjquerylibjsonliteknitrlifecyclemagrittrmemoisemimepillarpkgconfigprettyunitsprogressR6rappdirsreadxlrematchrlangrmarkdownsassstringistringrtibbletinytexutf8vctrswritexlxfunxml2yaml

Develop and use the dmdScheme

Rainer M Krug [email protected]

Rendered fromDevelop_and_Use_the_dmdScheme.Rmdusingknitr::rmarkdownon Sep 18 2024.

Last update: 2022-04-12
Started: 2020-06-11

Readme and manuals

Help Manual

Help pageTopics
Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme...'as_dmdScheme as_dmdScheme.dmdSchemeData_raw as_dmdScheme.dmdSchemeSet_raw as_dmdScheme.xml_document
Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme_raw...'as_dmdScheme_raw as_dmdScheme_raw.dmdSchemeData as_dmdScheme_raw.dmdSchemeSet as_dmdScheme_raw.xml_document
Generic function to convert an object to an object which can be saved as EMLas_eml as_eml.default
Generic function to convert an object to xmlas_xml as_xml.dmdSchemeData as_xml.dmdSchemeSet
Generic function to convert an object to a list containing xml(s)as_xml_list as_xml_list.dmdSchemeSet
Return cache directorycache
cat with linefeed at the end Titlecat_ln
Object of class 'dmdSchemeSet' containing the authorative definition of the dmdScheme.dmdScheme dmdSchemeData dmdSchemeSet
Object of class 'dmdSchemeSet' containing example data.dmdScheme_example
Object of class 'dmdScheme_raw ' containing the raw data as read in.dmdSchemeData_raw dmdSchemeSet_raw dmdScheme_raw
Format the metadata scheme fileformat_dmdScheme_xlsx
Replace tokens with vlues from a dmdSchemelookup_tokens
Create examples in working directorymake_example
Generic function to create the 'index.md' file to accompany the data deposit packagemake_index make_index.dmdSchemeSet
Create anew package skelleton to add functiuonality to the currently active scheme.make_new_package
Create new 'dmdScheme_validation' objectnew_dmdScheme_validation
Open the metadata scheme as a spreadsheet in a spreadsheet editoropen_new_spreadsheet
dmdScheme: A package containing the framework for Domain specific MetaData Schemespkg.dmdScheme
Internal function to ptint dmdScheme_validation of format 'summary'print_dmdScheme_validation_details
Internal function to ptint dmdScheme_validation of format 'summary'print_dmdScheme_validation_summary
Print method for 'dmdScheme_validation' objectprint.dmdScheme_validation
Print method for 'dmdSchemeData' objectprint.dmdSchemeData
Print method for 'dmdSchemeSet' objectprint.dmdSchemeSet
Read scheme data from Excel file into 'dmdSchemeSet' objectread_excel
Read scheme data from Excel file into 'dmdScheme_raw' objectread_excel_raw
Function to read x from an XML fileread_xml
Generic function for creating a report from an object 'x'report report.character report.dmdScheme_validation
Run shiny app.run_app
Functions to manage schemesscheme_active scheme_default scheme_download scheme_install scheme_installed scheme_install_r_package scheme_list scheme_list_in_repo scheme_repo scheme_uninstall scheme_use
Functions to manage schemesscheme_make
Functions to manage schemesscheme_path_index_template
Functions to manage schemesscheme_path_xlsx
Functions to manage schemesscheme_path_xml
Return tabs in scheme definition in Excel document which need to be transposed or if a tab has to be transposedtoTranspose
Convert older scheme versions of files to newer newer versionsupgrade_old_files
Extract all fields named error of class 'dmdScheme_validation'valErr_extract
Return info about error representationvalErr_info
Creates 'data.frame' from object of class 'dmdScheme_validation' for usage in 'details' of validationvalErr_isOK
Colour the 'text' by using the error colourvalErr_TextErrCol
Generic function to validate an object which represents a 'dmdScheme'validate validate.character validate.dmdSchemeSet_raw
Validate allowed valuesvalidateAllowedValues
Validate suggested valuesvalidateDataFileMetaDataDataFileExists
Validate id fieldvalidateIDField
Validate structure of 'dmdScheme' objectvalidateStructure
Validate suggested valuesvalidateSuggestedValues
Validate type of tabvalidateTypes
Write write x as an excel file to diskwrite_excel
Write write x as an XML file to diskwrite_xml