Update Description and website

traitecoevo · Nov 16, 2023 · 1d139e8 · ehwenk · Nov 16, 2023 · 1d139e8
1 parent 49a3a8c
commit 1d139e8
Show file tree

Hide file tree

Showing 102 changed files with 1,102 additions and 239 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Type: Package
 Package: traits.build
-Title: Package used to build an AusTraits data resource
+Title: A workflow for harmonising trait data from diverse sources into a documented standard structure.
 Version: 1.0.0
 Maintainer: Daniel Falster <[email protected]>
 Authors@R: c(
@@ -11,7 +11,7 @@ Authors@R: c(
     person("ARDC", role = c("fnd")),
     person("ARC", role = c("fnd"))
     )
-Description: This package enables harmonising of data from diverse sources. The code was originally built to support AusTraits, an open-source compilation of data on the traits of Australian plant species. For more information on AusTraits go to https://austraits.org.
+Description: The `traits.build` package provides a workflow to harmonise trait data from diverse sources. The code was originally built to support AusTraits (see Falster et al 2021, <doi:10.1038/s41597-021-01006-6>, <https://github.com/traitecoevo/autraits.build>) and has been generalised here to support construction of other trait databases. For detailed instructions and examples see <https://traitecoevo.github.io/traits.build-book/>.
 BugReports: https://github.com/traitecoevo/traits.build/issues
 URL: http://traitecoevo.github.io/traits.build/
 License: BSD_2_clause + file LICENCE

diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,7 @@
-# traits.build 0.9.0
+# traits.build 1.0.0
 
-* Moved vignettes to <https://traitecoevo.github.io/traits.build-book/>
-* migrate code from <http://traitecoevo.github.io/austraits.build/articles/>
+This is the first major release of the {traits.build} package, providing a workflow to enable harmonise data from diverse sources. The code was originally built to support AusTraits (see Falster et al 2021, <doi:10.1038/s41597-021-01006-6>, <https://github.com/traitecoevo/autraits.build>) and has been generalised here to support construction of other trait databases. Detailed instructions are available at
+
+- package website: <https://traitecoevo.github.io/traits.build/>
+- package book: <https://traitecoevo.github.io/traits.build-book/>
 
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -29,7 +29,7 @@ navbar:
 
 reference:
   - title: Building a dataset or compilation
-    desc: Functions that can be used when building individual datasets and entire compilation
+    desc: Functions that can be used when building individual datasets and entire compilation.
     contents:
     - '`build_setup_pipeline`'
     - '`build_combine`'
@@ -45,7 +45,7 @@ reference:
     - '`util_get_version`'
 
   - title: Creating metadata files
-    desc: functions that help you create metadata files
+    desc: Functions that help you create metadata files.
     contents:
     - '`dataset_test`'
     - '`metadata_create_template`'
@@ -67,7 +67,7 @@ reference:
     - '`dataset_find_taxon`'
 
   - title: Reading & writing files
-    desc: Enable reading and wring of various file types
+    desc: Enable reading and wring of various file types.
     contents:
     - '`read_csv_char`'
     - '`read_metadata`'
@@ -76,6 +76,15 @@ reference:
     - '`write_yaml`'
     - '`write_plaintext`'
 
+  - title: Working with outputs
+    desc: Functions to work with compiled traits.build objects.
+    contents:
+    - '`plot_trait_distribution_beeswarm`'
+    - '`check_pivot_duplicates`'
+    - '`check_pivot_wider`'
+    - '`db_traits_pivot_longer`'
+    - '`db_traits_pivot_wider`'
+
   - title: Building a compilation (private)
     desc: Private functions that are called in the background when building individual datasets and entire compilation. These are only of interest to developers.
     contents:
@@ -104,8 +113,9 @@ reference:
     - '`read_metadata_dataset`'
     - '`write_metadata_dataset`'
 
-  - title: Diverse utility functions for converting and working with various data types
-    desc: ~
+
+  - title: Diverse utility functions
+    desc: Diverse utility functions for converting and working with various data types.
     contents:
     - '`util_append_to_list`'
     - '`bib_print`'

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.1.1
 pkgdown: 2.0.7
 pkgdown_sha: ~
 articles: {}
-last_built: 2023-10-10T04:19Z
+last_built: 2023-11-16T05:34Z
 urls:
   reference: http://traitecoevo.github.io/traits.build/reference
   article: http://traitecoevo.github.io/traits.build/articles

diff --git a/docs/reference/bib_print.html b/docs/reference/bib_print.html
diff --git a/docs/reference/build_add_version.html b/docs/reference/build_add_version.html
diff --git a/docs/reference/build_combine.html b/docs/reference/build_combine.html
diff --git a/docs/reference/build_setup_pipeline.html b/docs/reference/build_setup_pipeline.html