Skip to content

Commit

Permalink
add installation from CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
Josep committed Apr 18, 2023
1 parent 581f705 commit 0b5b6d1
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 11 deletions.
6 changes: 6 additions & 0 deletions README.Rmd
Expand Up @@ -30,6 +30,12 @@ You can install the development version of CRediTas from [r-universe](https://r-
install.packages("CRediTas", repos = "https://ropensci.r-universe.dev")
```

Or you can install de long term release version from [CRAN](https://cran.r-project.org/web/packages/CRediTas/index.html) as usual:

``` r
install.packages("CRediTas")
```

## Example

The workflow is meant to work with three basic functions. First, we create a template table. It can be created as a `data.frame` and being populated in R. Or as a csv file and being populated in your preferred csv editor.
Expand Down
28 changes: 18 additions & 10 deletions README.md
Expand Up @@ -25,12 +25,20 @@ a table (csv) and then converting this table to CRediT statement format.
## Installation

You can install the development version of CRediTas from
[r-universe](https://r-universe.dev) with:
[r-universe](https://r-universe.dev/) with:

``` r
install.packages("CRediTas", repos = "https://ropensci.r-universe.dev")
```

Or you can install de long term release version from
[CRAN](https://cran.r-project.org/web/packages/CRediTas/index.html) as
usual:

``` r
install.packages("CRediTas")
```

## Example

The workflow is meant to work with three basic functions. First, we
Expand Down Expand Up @@ -76,10 +84,10 @@ Once the `cras_table` is populated, for instance:

| Authors | Conceptualization | Methodology | Software | Validation | Formal Analysis | Investigation | Resources | Data curation | Writing - original draft | Writing - review & editing | Visualization | Supervision | Project administration | Funding acquisition |
|:-----------------------|------------------:|------------:|---------:|-----------:|----------------:|--------------:|----------:|--------------:|-------------------------:|---------------------------:|--------------:|------------:|-----------------------:|--------------------:|
| Friedrich Ratzel | 1 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 0 |
| Pau Vidal de la Blache | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 |
| Friedrich Ratzel | 1 | 1 | 1 | 0 | 1 | 1 | 1 | 0 | 0 | 1 | 0 | 0 | 1 | 0 |
| Pau Vidal de la Blache | 0 | 0 | 1 | 0 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 |
| Pau Vila | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| Élisée Reclus | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 1 | 1 | 0 | 1 | 1 | 1 |
| Élisée Reclus | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 1 | 1 | 1 |

A text file can be generated following the CRediT author statement
format. Since `drop = TRUE` by default, the authors without contribution
Expand All @@ -93,12 +101,12 @@ cras_write(cras_table, textfile, markdown = TRUE, quiet = TRUE)

If you open the text file, you will find this:

**Friedrich Ratzel:** Conceptualization, Formal Analysis, Investigation,
Writing - original draft, Visualization, Project administration **Pau
Vidal de la Blache:** Conceptualization, Software, Investigation,
Project administration, Funding acquisition **Élisée Reclus:** Software,
Validation, Resources, Writing - original draft, Writing - review &
editing, Supervision, Project administration, Funding acquisition
**Friedrich Ratzel:** Conceptualization, Methodology, Software, Formal
Analysis, Investigation, Resources, Writing - review & editing, Project
administration **Pau Vidal de la Blache:** Software, Formal Analysis,
Investigation, Resources, Funding acquisition **Élisée Reclus:**
Methodology, Resources, Visualization, Supervision, Project
administration, Funding acquisition

## Related packages

Expand Down
8 changes: 7 additions & 1 deletion vignettes/get_started.Rmd
Expand Up @@ -21,12 +21,18 @@ The goal of CRediTas is to facilitate the tedious job of creating [CRediT author

## Installation

You can install the development version of CRediTas from [r-universe](https://r-universe.dev) with:
You can install the development version of CRediTas from [r-universe](https://r-universe.dev/) with:

``` r
install.packages("CRediTas", repos = "https://ropensci.r-universe.dev")
```

Or you can install de long term release version from [CRAN](https://cran.r-project.org/web/packages/CRediTas/index.html) as usual:

``` r
install.packages("CRediTas")
```

## Create a template

The workflow is meant to work with three basic functions. First, we create a template table. It can be created as a `data.frame` and being populated in R.
Expand Down

0 comments on commit 0b5b6d1

Please sign in to comment.