From 2588d2720c3de357d505e51a5521b084cbc55fb0 Mon Sep 17 00:00:00 2001 From: Jamie Kass Date: Tue, 11 Jun 2024 18:03:06 +0900 Subject: [PATCH 1/2] change to version 1.0.0 in accordance with Ecography software notes --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 5ed0f9b..f6257ce 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: sdmverse Type: Package Title: A Meta-Package For Harnessing The Growing Diversity Of Species Distribution Modeling Packages -Version: 0.1.0 +Version: 1.0.0 Authors@R: c( person("Sylvain", "Schmitt", email="sylvain.m.schmitt@gmail.com", role=c("aut", "cre"), comment = c(ORCID = "0000-0001-7759-7106")), person("Jamie", "Kass", email="jamie.m.kass@gmail.com", role="aut", comment = c(ORCID = "0000-0002-9432-895X")), From 6c96e4d5d305633aba004014217a1f9d36f7e7b9 Mon Sep 17 00:00:00 2001 From: Jamie Kass Date: Mon, 24 Jun 2024 18:37:23 +0900 Subject: [PATCH 2/2] text edits for md files --- CONTRIBUTING.md | 13 +++++-------- EDITORING.md | 4 ++-- README.md | 7 ++----- REVIEWING.md | 2 +- 4 files changed, 10 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e7257e4..74dbbf1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,21 +8,18 @@ #### **Why?** -*sdmverse* is a collaborative metapackage for listing all the metadata of the Species Distribution Modelling (SDM) packages -Thus, *sdmverse* depends on the contribution and reviews of SDM packages maintainers to exist. +*sdmverse* is a collaborative metapackage for collecting and visualizing metadata for R packages focusing on species distribution models (SDMs). Thus, *sdmverse* depends on contributions and reviews from maintainers and developers of SDM packages maintainers to keep up-to-date. -The package metadata is located in independent YAML files in `inst/extdata/packages/`. -For example, take a look at [*SSDM* metadata](https://github.com/sylvainschmitt/sdmverse/blob/main/inst/extdata/packages/SSDM.yaml). +The package metadata is located in independent YAML files in `inst/extdata/packages/`. For example, take a look at [*SSDM* metadata](https://github.com/sylvainschmitt/sdmverse/blob/main/inst/extdata/packages/SSDM.yaml). #### **How?** -If you want to contribute, please fork the repository on GitHub. -Then, online on GitHub, in Rstudio or with your favourite editor, create a YAML file in `inst/extdata/packages/` called `{your_package}.yaml`. +If you want to contribute, please fork this repository on GitHub. +Then, on GitHub, in RStudio, or with your favorite editor, create a YAML file in `inst/extdata/packages/` named `{your_package}.yaml`. Copy and fill in the contents of the file [`example.yaml`](https://github.com/sylvainschmitt/sdmverse/blob/main/inst/extdata/packages/example.yaml). Details of the various metadata fields are given below. Once your file is ready and online on your GitHub fork, open a pull request to contribute to *sdmverse* named "`my_package`submission". -Please provide in your pull request message a quick list -and if possible a brief description of the functions of your package corresponding to each field for which you have answered yes. +Please provide in your pull request message a quick list, and if possible, a brief description of the functions of your package corresponding to each field for which you have answered yes. You can then ask an editor to start the review process. Remember that the review process is voluntary, so try to be understanding with reviewers and editors. Once the review process has been successfully completed, we will be happy to include your package in the *sdmverse* to help users discover it. diff --git a/EDITORING.md b/EDITORING.md index 2b81ceb..c1de727 100644 --- a/EDITORING.md +++ b/EDITORING.md @@ -8,7 +8,7 @@ #### **Why?** -*sdmverse* is a collaborative metapackage that catalogues metadata for R packages that focus on Species Distribution Modeling (SDM). This package depends on the contributions, reviews, and edits of SDM package maintainers. +*sdmverse* is a collaborative metapackage for collecting and visualizing metadata for R packages focusing on species distribution models (SDMs). This package depends on the contributions, reviews, and edits of SDM package maintainers. Metadata for packages are found in YAML files located in `inst/extdata/packages/`. For example, take a look at [*SSDM* metadata](https://github.com/sylvainschmitt/sdmverse/blob/main/inst/extdata/packages/SSDM.yaml). @@ -24,7 +24,7 @@ Here is the list of actions to do (to be improved with text): Ex. Dear {name}, thanks for your submission. Unfortunately, the metadata in the fields {fields} do not match those on CRAN {link to GitHub Action} 3. Seek reviewers: - Ex. I'm looking for a second reviewer: @{collaborators} are you available? Please have a look at the [reviewing guidelines](https://github.com/sylvainschmitt/sdmverse/blob/main/REVIEWING.md) + Ex. I'm looking for a second reviewer: @{collaborators} are you available? Please have a look at the [reviewing guidelines](https://github.com/sylvainschmitt/sdmverse/blob/main/REVIEWING.md) 4. Wait for review approval. 5. Make a decision: Ex. Unfortunately, your package does not meet the `sdmverse` requirements for inclusion, so I must reject your pull request. If you have questions, please post an Issue in this repository. diff --git a/README.md b/README.md index d7eb969..f32b26b 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,7 @@ [![lint](https://github.com/sylvainschmitt/sdmverse/workflows/lint/badge.svg)](https://github.com/sylvainschmitt/sdmverse/actions?query=workflow%3Alint) [![check-cran-metadata](https://github.com/sylvainschmitt/sdmverse/actions/workflows/check-cran-metadata.yaml/badge.svg)](https://github.com/sylvainschmitt/sdmverse/actions?query=workflow%3Acheck-cran-metadata) -*sdmverse* is a collaborative metapackage for listing all the metadata of the Species Distribution Modelling (SDM) packages. -*sdmverse* includes a graphical interface available locally or online (see below). -*sdmverse* integrates metadata from SDM packages and checks their validity against the CRAN metadata for perenity. -If you want to contribute with your package metadata, please use the contribution guidelines (see below). +*sdmverse* is a collaborative metapackage for collecting and visualizing metadata for R packages focusing on species distribution models (SDMs), including a graphical interface for local or online use. Contributions of package metadata to *sdmverse* are checked automatically for validity against CRAN metadata. If you want to contribute your package metadata, please consult the contribution guidelines (see below). ## Online @@ -40,4 +37,4 @@ sdmverse::launch_app() ## Contribution -If you want to contribute with your package metadata, please use a pull request following [the contribution guidelines](https://github.com/sylvainschmitt/sdmverse/blob/main/CONTRIBUTING.md). +If you want to contribute your package metadata, please submit a pull request following [the contribution guidelines](https://github.com/sylvainschmitt/sdmverse/blob/main/CONTRIBUTING.md). diff --git a/REVIEWING.md b/REVIEWING.md index ecaa58e..f071ff6 100644 --- a/REVIEWING.md +++ b/REVIEWING.md @@ -8,7 +8,7 @@ #### **Why?** -*sdmverse* is a collaborative metapackage that catalogues metadata for R packages that focus on Species Distribution Modeling (SDM). This package depends on the contributions, reviews, and edits of SDM package maintainers. +*sdmverse* is a collaborative metapackage for collecting and visualizing metadata for R packages focusing on species distribution models (SDMs). This package depends on the contributions, reviews, and edits of SDM package maintainers. Metadata for packages are found in YAML files located in `inst/extdata/packages/`. For example, take a look at [*SSDM* metadata](https://github.com/sylvainschmitt/sdmverse/blob/main/inst/extdata/packages/SSDM.yaml).