Skip to content

Commit 5534d21

Browse files
committed
documentation update via devtools::document and pkgdown::build_site_github_pages
1 parent 6336e94 commit 5534d21

15 files changed

Lines changed: 31 additions & 25 deletions

docs/articles/DPchecker.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/index.html

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ pkgdown: 2.2.0
33
pkgdown_sha: ~
44
articles:
55
DPchecker: DPchecker.html
6-
last_built: 2026-04-23T02:54Z
6+
last_built: 2026-05-19T16:58Z

docs/reference/run_congruence_checks.html

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/run_congruence_checks.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,8 @@ run_congruence_checks(dir)
101101
#> ✔ Any individual Creators in metadata have a surNames with less than three
102102
#> words.
103103
#> ! Publication date, 2022, predates the Data Package Reference Type.
104-
#> ✔ Data package title is present in metadata.
104+
#> ! Data package title appears to contain acronyms. Consider revising to spell
105+
#> out acronyms. Use `EMLeditor::set_title()` to revise.
105106
#> ✔ Metadata contains keyword(s).
106107
#> ✔ Metadata states data was created by or for NPS.
107108
#> ✔ Metadata indicates the publisher is the National Park Service.

docs/reference/test_dp_abstract.html

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/test_dp_abstract.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Test EML abstract
22

33
`test_dp_abstract()` inspects EML for presence of a data package
4-
abstract. The test Fails with an error if the abstract is absent. If the
5-
abstract is present, the test fails with a warning if the abstract is
6-
\<20 words, \>250 words, or contains a subset of common characters that
7-
indicate improper formatting. Otherwise the test passes.
4+
abstract. The test Fails with an error if the abstract is absent or
5+
greater than 10,000 characters (required for data.gov). If the abstract
6+
is present, the test fails with a warning if the abstract is \<20 words,
7+
\>250 words, or contains a subset of common characters that indicate
8+
improper formatting. Otherwise the test passes.
89

910
## Usage
1011

docs/reference/test_dp_title.html

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/test_dp_title.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Test data package title
22

33
`test_dp_title()` tests EML metadata for presence of a data package
4-
title. The test fails with an error if the title is absent. The test
5-
fails with a warning if the title is \> 20 or \< 5 words. Otherwise, the
6-
test passes.
4+
title. The test fails with an error if the title is absent or the title
5+
is greater than 300 characters (a data.gov requirement). The test fails
6+
with a warning if the title is \> 20 or \< 5 words. Otherwise, the test
7+
passes.
78

89
## Usage
910

0 commit comments

Comments
 (0)