diff --git a/docs/404.html b/docs/404.html index 0f8c863..55fbabd 100644 --- a/docs/404.html +++ b/docs/404.html @@ -24,7 +24,7 @@ DPchecker - 0.1.0 + 0.2.0 + + + + + +
+
+
+

Check for DOI +Checks if DOI is present in metadata. Does not currently validate DOI.

+ +
test_doi.Rd
+
+ +
+

Check for DOI +Checks if DOI is present in metadata. Does not currently validate DOI.

+
+ +
+

Usage

+ 
test_doi(metadata = load_metadata(directory))
+
+ +
+

Arguments

+
metadata
+

The metadata object returned by load_metadata. If parameter not provided, defaults to calling load_metadata in current project directory.

+ +
+
+

Value

+ + +

Invisibly returns metadata.

+
+ +
+

Examples

+ 
meta <- load_metadata(DPchecker_example("BICY_veg"))
+#> Data are provided for example use only. Do not assume that they are complete, accurate, or up to date.
+test_geographic_cov(meta)
+#> ✔ Metadata contains geographic coverage element
+
+
+
+ + +
+ + + + + + + diff --git a/docs/reference/test_dup_meta_entries.html b/docs/reference/test_dup_meta_entries.html index 37a9db6..336d0ed 100644 --- a/docs/reference/test_dup_meta_entries.html +++ b/docs/reference/test_dup_meta_entries.html @@ -10,7 +10,7 @@ DPchecker - 0.1.0 + 0.2.0 + + + + + +
+
+
+

Check for Geographic Coverage +Checks if geographic coverage element is present in metadata. Does not perform any validation of geographic coverage information.

+ +
test_geographic_cov.Rd
+
+ +
+

Check for Geographic Coverage +Checks if geographic coverage element is present in metadata. Does not perform any validation of geographic coverage information.

+
+ +
+

Usage

+ 
test_geographic_cov(metadata = load_metadata(directory))
+
+ +
+

Arguments

+
metadata
+

The metadata object returned by load_metadata. If parameter not provided, defaults to calling load_metadata in current project directory.

+ +
+
+

Value

+ + +

Invisibly returns metadata.

+
+ +
+

Examples

+ 
meta <- load_metadata(DPchecker_example("BICY_veg"))
+#> Data are provided for example use only. Do not assume that they are complete, accurate, or up to date.
+test_geographic_cov(meta)
+#> ✔ Metadata contains geographic coverage element
+
+
+
+ + +
+ + + + + + + diff --git a/docs/reference/test_header_num.html b/docs/reference/test_header_num.html index 8d6bacb..27c0f69 100644 --- a/docs/reference/test_header_num.html +++ b/docs/reference/test_header_num.html @@ -10,7 +10,7 @@ DPchecker - 0.1.0 + 0.2.0 + + + + + +
+
+
+

Check for Publisher +Checks if publisher information is present in metadata, with option to require valid NPS publisher information.

+ +
test_publisher.Rd
+
+ +
+

Check for Publisher +Checks if publisher information is present in metadata, with option to require valid NPS publisher information.

+
+ +
+

Usage

+ 
test_publisher(metadata = load_metadata(directory), require_nps = FALSE)
+
+ +
+

Arguments

+
metadata
+

The metadata object returned by load_metadata. If parameter not provided, defaults to calling load_metadata in current project directory.

+ + +
require_nps
+

If TRUE, throw an error if publisher information is not correct for NPS published data.

+ +
+
+

Value

+ + +

Invisibly returns metadata.

+
+ +
+

Examples

+ 
meta <- load_metadata(DPchecker_example("BICY_veg"))
+#> Data are provided for example use only. Do not assume that they are complete, accurate, or up to date.
+test_publisher(meta)
+#> ✔ Metadata contains publisher element.
+
+
+
+ + +
+ + + + + + + diff --git a/docs/reference/test_taxonomic_cov.html b/docs/reference/test_taxonomic_cov.html new file mode 100644 index 0000000..d7404aa --- /dev/null +++ b/docs/reference/test_taxonomic_cov.html @@ -0,0 +1,94 @@ + +Check for Taxonomic Coverage +Checks if taxonomic coverage element is present in metadata. Does not perform any validation of taxonomic coverage information. — test_taxonomic_cov • DPchecker + Skip to contents + + +
+
+
+

Check for Taxonomic Coverage +Checks if taxonomic coverage element is present in metadata. Does not perform any validation of taxonomic coverage information.

+ +
test_taxonomic_cov.Rd
+
+ +
+

Check for Taxonomic Coverage +Checks if taxonomic coverage element is present in metadata. Does not perform any validation of taxonomic coverage information.

+
+ +
+

Usage

+ 
test_taxonomic_cov(metadata = load_metadata(directory))
+
+ +
+

Arguments

+
metadata
+

The metadata object returned by load_metadata. If parameter not provided, defaults to calling load_metadata in current project directory.

+ +
+
+

Value

+ + +

Invisibly returns metadata.

+
+ +
+

Examples

+ 
meta <- load_metadata(DPchecker_example("BICY_veg"))
+#> Data are provided for example use only. Do not assume that they are complete, accurate, or up to date.
+test_taxonomic_cov(meta)
+#> ✔ Metadata contains taxonomic coverage element.
+
+
+
+ + +
+ + + + + + + diff --git a/docs/reference/test_valid_fieldnames.html b/docs/reference/test_valid_fieldnames.html new file mode 100644 index 0000000..af2cbcc --- /dev/null +++ b/docs/reference/test_valid_fieldnames.html @@ -0,0 +1,93 @@ + +Test Field Names for Invalid Characters — test_valid_fieldnames • DPchecker + Skip to contents + + +
+
+
+

Test Field Names for Invalid Characters

+ +
test_valid_fieldnames.Rd
+
+ +
+

test_valid_fieldnames checks for field names in the metadata that contain invalid special characters. Only underscores and alphanumeric characters are permitted, and names must begin with a letter.

+
+ +
+

Usage

+ 
test_valid_fieldnames(metadata = load_metadata(here::here()))
+
+ +
+

Arguments

+
metadata
+

The metadata object returned by load_metadata. If parameter not provided, defaults to calling load_metadata in current project directory.

+ +
+
+

Value

+ + +

Invisibly returns metadata.

+
+
+

Details

+

You should run test_fields_match() before you run this function, since this function only checks the field names in the metadata.

+
+ +
+

Examples

+ 
meta <- load_metadata(DPchecker_example("BICY_veg"))
+#> Data are provided for example use only. Do not assume that they are complete, accurate, or up to date.
+test_valid_fieldnames(meta)
+#> ✔ Field names begin with a letter and do not contain spaces or special
+#>   characters.
+
+
+
+ + +
+ + + + + + + diff --git a/docs/reference/test_valid_filenames.html b/docs/reference/test_valid_filenames.html new file mode 100644 index 0000000..435ed15 --- /dev/null +++ b/docs/reference/test_valid_filenames.html @@ -0,0 +1,93 @@ + +Test File Names for Invalid Characters — test_valid_filenames • DPchecker + Skip to contents + + +
+
+
+

Test File Names for Invalid Characters

+ +
test_valid_filenames.Rd
+
+ +
+

test_valid_filenames checks for file names in the metadata that contain invalid special characters. Only underscores and alphanumeric characters are permitted, and names must begin with a letter.

+
+ +
+

Usage

+ 
test_valid_filenames(metadata = load_metadata(here::here()))
+
+ +
+

Arguments

+
metadata
+

The metadata object returned by load_metadata. If parameter not provided, defaults to calling load_metadata in current project directory.

+ +
+
+

Value

+ + +

Invisibly returns metadata.

+
+
+

Details

+

You should run test_file_name_match() before you run this function, since this function only checks the file names in the metadata.

+
+ +
+

Examples

+ 
meta <- load_metadata(DPchecker_example("BICY_veg"))
+#> Data are provided for example use only. Do not assume that they are complete, accurate, or up to date.
+test_valid_filenames(meta)
+#> ✔ File names begin with a letter and do not contain spaces or special
+#>   characters.
+
+
+
+ + +
+ + + + + + + diff --git a/docs/reference/test_validate_schema.html b/docs/reference/test_validate_schema.html index 855b6aa..bb8538d 100644 --- a/docs/reference/test_validate_schema.html +++ b/docs/reference/test_validate_schema.html @@ -10,7 +10,7 @@ DPchecker - 0.1.0 + 0.2.0