Skip to content
This repository was archived by the owner on Oct 20, 2023. It is now read-only.

Commit 8eca863

Browse files
committed
Add code of conduct for collaboration + News
1 parent 051e42f commit 8eca863

32 files changed

+545
-63
lines changed

.Rbuildignore

+2
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@ man/figures
66
^appveyor\.yml$
77
^README-.*\.png$
88
^codecov\.yml$
9+
^_pkgdown\.yml$
10+
^docs$

CODE_OF_CONDUCT.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6+
7+
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8+
9+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10+
11+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12+
13+
This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html
14+

DESCRIPTION

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Package: sticRs
22
Type: Package
3-
Title: A Package to Set, Manage and Analyze STICS Simulations
3+
Title: A Package to Set, Manage and Analyze STICS Simulations https://vezy.github.io/sticRs/
44
Date: 2018-05-11
5-
Version: 0.2.0
5+
Version: 1.0.0
66
Authors@R: c(person("Remi", "Vezy",, "vezy.remi@gmail.com", c("aut", "cre", "cph"),comment = c(ORCID = "0000-0002-0808-1461")),
77
person("STICS", "group",, "", c("aut", "cph")))
88
Description: sticRs allow users to set simulations (USM) as javaSTICS does, to run them in different folders on in sequential,

NEWS.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# sticRs 1.0.0
2+
3+
* Added a `NEWS.md` file to track changes to the package.
4+
* First stable release of the package

README.Rmd

+9-3
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,13 @@ options(tibble.print_min = 5, tibble.print_max = 5)
1919
# sticRs: the [STICS](https://www6.paca.inra.fr/stics_eng/) model R package for developers <img src="man/figures/logo.jpg" alt="logo" width="300" align="right" />
2020
<!-- <img src="man/figures/logo.png" alt="logo" style="width:30%;height:auto;" align="right" /> -->
2121
<!-- [![Travis build status](https://travis-ci.com/VEZY/DynACof.svg?branch=master)](https://travis-ci.org/VEZY/DynACof) -->
22-
[![Project Status: WIPInitial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)
22+
[![Project Status: ActiveThe project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
2323
[![Travis Build Status](https://travis-ci.com/VEZY/sticRs.svg?branch=master)](https://travis-ci.com/VEZY/sticRs)
2424
[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/cu1nyxrhc6nmpt5i/branch/master?svg=true)](https://ci.appveyor.com/project/VEZY/sticrs/branch/master)
2525
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
2626
[![Coverage status](https://codecov.io/gh/VEZY/sticRs/branch/master/graph/badge.svg)](https://codecov.io/github/VEZY/sticRs?branch=master)
2727

28+
2829
## Overview
2930

3031
This package allows the user to programmatically:
@@ -47,6 +48,7 @@ This package allows the user to programmatically:
4748

4849
The package is under intensive development, so you can fill an issue or request me a feature [here](https://github.com/VEZY/sticRs/issues ) at any time.
4950

51+
5052
## Installation
5153

5254
The development version from [GitHub](https://github.com/) can be installed with:
@@ -185,11 +187,15 @@ The output from [`sensitive_stics`](R/sensitive_stics.R) is a list of two:
185187
Example data are available in the [tests folder](https://github.com/VEZY/sticRs/tree/master/tests/testthat/example_data). It is a dummy USM of wheat in self-intercropping, meaning that the model is run on the same plant planted in intercropping, to test if the model outputs are close to a sole crop simulation.
186188
**Warning**: this example USM is made primarily to test the sticRs package, and is available to the user only for training, not for model validation. These data are dummy data that were entirely fabricated from scratch. It is not reflecting any real observations.
187189

188-
## Acknowledgments
190+
## Code of conduct
191+
192+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
193+
194+
## Authors and acknowledgments
189195

190196
The STICS (Simulateur mulTIdisciplinaire pour les Cultures Standard, or multidisciplinary simulator for standard crops) model is a dynamic, generic and robust model aiming to simulate the soil-crop-atmosphere system. It was first developed in 1996 by INRA -the French National Institute for Agricultural research- by Nadine Brisson and Dominique Ripoche. An overview of the model is available [here](https://www6.paca.inra.fr/stics_eng/About-us/Stics-model-overview).
191197

192-
The sticRs package was developed thanks to the European H2020 funded [ReMIX project](https://www.remix-intercrops.eu/).
198+
The sticRs package was developed by [Rémi Vezy](https://remi-vezy.netlify.com/) and the [STICS group](https://www6.paca.inra.fr/stics_eng/) thanks to the European H2020 funded [ReMIX project](https://www.remix-intercrops.eu/).
193199

194200
![ReMIX logo](man/figures/remix_logo.jpg)
195201
---

README.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ sticRs: the [STICS](https://www6.paca.inra.fr/stics_eng/) model R package for de
66

77
<!-- <img src="man/figures/logo.png" alt="logo" style="width:30%;height:auto;" align="right" /> -->
88
<!-- [![Travis build status](https://travis-ci.com/VEZY/DynACof.svg?branch=master)](https://travis-ci.org/VEZY/DynACof) -->
9-
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip) [![Travis Build Status](https://travis-ci.com/VEZY/sticRs.svg?branch=master)](https://travis-ci.com/VEZY/sticRs) [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/cu1nyxrhc6nmpt5i/branch/master?svg=true)](https://ci.appveyor.com/project/VEZY/sticrs/branch/master) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Coverage status](https://codecov.io/gh/VEZY/sticRs/branch/master/graph/badge.svg)](https://codecov.io/github/VEZY/sticRs?branch=master)
9+
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Travis Build Status](https://travis-ci.com/VEZY/sticRs.svg?branch=master)](https://travis-ci.com/VEZY/sticRs) [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/cu1nyxrhc6nmpt5i/branch/master?svg=true)](https://ci.appveyor.com/project/VEZY/sticrs/branch/master) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Coverage status](https://codecov.io/gh/VEZY/sticRs/branch/master/graph/badge.svg)](https://codecov.io/github/VEZY/sticRs?branch=master)
10+
11+
The package documentation is available on the sticRs website: <https://vezy.github.io/sticRs/>
1012

1113
Overview
1214
--------
@@ -177,12 +179,18 @@ Example data
177179
Example data are available in the [tests folder](https://github.com/VEZY/sticRs/tree/master/tests/testthat/example_data). It is a dummy USM of wheat in self-intercropping, meaning that the model is run on the same plant planted in intercropping, to test if the model outputs are close to a sole crop simulation.
178180
**Warning**: this example USM is made primarily to test the sticRs package, and is available to the user only for training, not for model validation. These data are dummy data that were entirely fabricated from scratch. It is not reflecting any real observations.
179181

180-
Acknowledgments
181-
---------------
182+
Authors and acknowledgments
183+
---------------------------
182184

183185
The STICS (Simulateur mulTIdisciplinaire pour les Cultures Standard, or multidisciplinary simulator for standard crops) model is a dynamic, generic and robust model aiming to simulate the soil-crop-atmosphere system. It was first developed in 1996 by INRA -the French National Institute for Agricultural research- by Nadine Brisson and Dominique Ripoche. An overview of the model is available [here](https://www6.paca.inra.fr/stics_eng/About-us/Stics-model-overview).
184186

185-
The sticRs package was developed thanks to the European H2020 funded [ReMIX project](https://www.remix-intercrops.eu/).
187+
The sticRs package was developed by [Rémi Vezy](https://remi-vezy.netlify.com/) and the [STICS group](https://www6.paca.inra.fr/stics_eng/) thanks to the European H2020 funded [ReMIX project](https://www.remix-intercrops.eu/).
186188

187189
![ReMIX logo](man/figures/remix_logo.jpg)
188-
-----------------------------------------
190+
191+
Code of conduct
192+
---------------
193+
194+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
195+
196+
------------------------------------------------------------------------

_pkgdown.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
url: https://vezy.github.io/sticRs/
2+
3+
authors:
4+
Remi Vezy:
5+
href: https://remi-vezy.netlify.com
6+
STICS group:
7+
href: https://www6.paca.inra.fr/stics_eng

docs/CODE_OF_CONDUCT.html

+134
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/LICENSE-text.html

+5-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/authors.html

+28-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)