Domain Specific MetaData Scheme


[Up] [Top]

Documentation for package ‘dmdScheme’ version 1.2.6

Help Pages

as_dmdScheme Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme...'
as_dmdScheme.dmdSchemeData_raw Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme...'
as_dmdScheme.dmdSchemeSet_raw Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme...'
as_dmdScheme.xml_document Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme...'
as_dmdScheme_raw Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme_raw...'
as_dmdScheme_raw.dmdSchemeData Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme_raw...'
as_dmdScheme_raw.dmdSchemeSet Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme_raw...'
as_dmdScheme_raw.xml_document Generic function to convert the data stored in the object 'x' into a new object of class 'dmdScheme_raw...'
as_eml Generic function to convert an object to an object which can be saved as EML
as_eml.default Generic function to convert an object to an object which can be saved as EML
as_xml Generic function to convert an object to xml
as_xml.dmdSchemeData Generic function to convert an object to xml
as_xml.dmdSchemeSet Generic function to convert an object to xml
as_xml_list Generic function to convert an object to a list containing xml(s)
as_xml_list.dmdSchemeSet Generic function to convert an object to a list containing xml(s)
cache Return cache directory
cat_ln cat with linefeed at the end Title
dmdScheme Object of class 'dmdSchemeSet' containing the authorative definition of the dmdScheme.
dmdSchemeData Object of class 'dmdSchemeSet' containing the authorative definition of the dmdScheme.
dmdSchemeData_raw Object of class 'dmdScheme_raw ' containing the raw data as read in.
dmdSchemeSet Object of class 'dmdSchemeSet' containing the authorative definition of the dmdScheme.
dmdSchemeSet_raw Object of class 'dmdScheme_raw ' containing the raw data as read in.
dmdScheme_example Object of class 'dmdSchemeSet' containing example data.
dmdScheme_raw Object of class 'dmdScheme_raw ' containing the raw data as read in.
format_dmdScheme_xlsx Format the metadata scheme file
lookup_tokens Replace tokens with vlues from a dmdScheme
make_example Create examples in working directory
make_index Generic function to create the 'index.md' file to accompany the data deposit package
make_index.dmdSchemeSet Generic function to create the 'index.md' file to accompany the data deposit package
make_new_package Create anew package skelleton to add functiuonality to the currently active scheme.
new_dmdScheme_validation Create new 'dmdScheme_validation' object
open_new_spreadsheet Open the metadata scheme as a spreadsheet in a spreadsheet editor
pkg.dmdScheme dmdScheme: A package containing the framework for Domain specific MetaData Schemes
print.dmdSchemeData Print method for 'dmdSchemeData' object
print.dmdSchemeSet Print method for 'dmdSchemeSet' object
print.dmdScheme_validation Print method for 'dmdScheme_validation' object
print_dmdScheme_validation_details Internal function to ptint dmdScheme_validation of format 'summary'
print_dmdScheme_validation_summary Internal function to ptint dmdScheme_validation of format 'summary'
read_excel Read scheme data from Excel file into 'dmdSchemeSet' object
read_excel_raw Read scheme data from Excel file into 'dmdScheme_raw' object
read_xml Function to read x from an XML file
report Generic function for creating a report from an object 'x'
report.character Generic function for creating a report from an object 'x'
report.dmdScheme_validation Generic function for creating a report from an object 'x'
run_app Run shiny app.
scheme_active Functions to manage schemes
scheme_default Functions to manage schemes
scheme_download Functions to manage schemes
scheme_install Functions to manage schemes
scheme_installed Functions to manage schemes
scheme_install_r_package Functions to manage schemes
scheme_list Functions to manage schemes
scheme_list_in_repo Functions to manage schemes
scheme_make Functions to manage schemes
scheme_path_index_template Functions to manage schemes
scheme_path_xlsx Functions to manage schemes
scheme_path_xml Functions to manage schemes
scheme_repo Functions to manage schemes
scheme_uninstall Functions to manage schemes
scheme_use Functions to manage schemes
toTranspose Return tabs in scheme definition in Excel document which need to be transposed or if a tab has to be transposed
upgrade_old_files Convert older scheme versions of files to newer newer versions
valErr_extract Extract all fields named error of class 'dmdScheme_validation'
valErr_info Return info about error representation
valErr_isOK Creates 'data.frame' from object of class 'dmdScheme_validation' for usage in 'details' of validation
valErr_TextErrCol Colour the 'text' by using the error colour
validate Generic function to validate an object which represents a 'dmdScheme'
validate.character Generic function to validate an object which represents a 'dmdScheme'
validate.dmdSchemeSet_raw Generic function to validate an object which represents a 'dmdScheme'
validateAllowedValues Validate allowed values
validateDataFileMetaDataDataFileExists Validate suggested values
validateIDField Validate id field
validateStructure Validate structure of 'dmdScheme' object
validateSuggestedValues Validate suggested values
validateTypes Validate type of tab
write_excel Write write x as an excel file to disk
write_xml Write write x as an XML file to disk