Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

older text changes #46

Merged
merged 2 commits into from
Oct 14, 2024
Merged

older text changes #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2588d27
change to version 1.0.0 in accordance with Ecography software notes
jamiemkass Jun 11, 2024
6c96e4d
text edits for md files
jamiemkass Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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")),
Expand Down
4 changes: 2 additions & 2 deletions EDITORING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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.
Expand Down
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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).
2 changes: 1 addition & 1 deletion REVIEWING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Loading