Skip to content

Commit

Permalink
small fixes to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
marton-balazs-kovacs committed Aug 24, 2021
1 parent 8fc30f9 commit bd38b04
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 29 deletions.
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* The app allows users to review their contributors_table within the app even if it does not pass the validation checks.
* There are two new columns added to the contributors_table template: ORCiD iD and Funding.
* The name of the CRediT taxonomy roles in the contributors_table are now fixed as well their URLs directing to each role in the taxonomy's documentation.
* The contributors_table template is now empty. However, a filled out example template is added to the package as an external datafile. See the local_use vignette on how to load this example file.
* The contributors_table template is now empty. However, a filled out example template is added to the package as an external datafile. See `vignette("local_use")` on how to load this example file.
* The title page output option now allows users to add multiple first authors and prints an additional text listing the names of the shared first authors and the email address of the corresponding author.
* The app got a new, cleaner look.

Expand Down
4 changes: 2 additions & 2 deletions R/rename.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Functions renamed in tenzing 0.2.0
#'
#' @description
#' `r lifecycle::badge(deprecated)`
#' @description
#' `r lifecycle::badge('deprecated')`
#'
#' In `tenzing 0.2.0` we renamed the `infosheet` to `contributors_table`
#' in all functions, arguments, and documentation as the new name
Expand Down
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ knitr::opts_chunk$set(

Tenzing, an easy-to-use web-based app, allows researchers to generate reports about the contribution of each team member on a project using CRediT, for insertion into their manuscripts and for publishers to potentially incorporate into article metadata.

[CRediT](https://www.casrai.org/credit.html) (Contributor Roles Taxonomy) is a taxonomy of 14 categories of contributions to scientific scholarly output. Each researcher can indicate which category they contributed to in a scholarly project.
[CRediT](http://credit.niso.org/) (Contributor Roles Taxonomy) is a taxonomy of 14 categories of contributions to scientific scholarly output. Each researcher can indicate which category they contributed to in a scholarly project.

The app is named after the Nepali-Indian Sherpa Tenzing Norgay, who was one of the two individuals who reached the summit of Mount Everest for the first time. Despite his essential contribution, he received less credit than his partner, the New Zealand mountaineer Edmund Hillary.

Expand All @@ -41,7 +41,7 @@ Tenzing can be used either via the web app or via R.

### Using the web app

You can use the app at [https://martonbalazskovacs.shinyapps.io/tenzing/](https://martonbalazskovacs.shinyapps.io/tenzing/).
You can use the app at [https://tenzing.club/](https://tenzing.club/).

You can alternatively run the app locally on your own computer by following these instructions:

Expand Down
32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ reports about the contribution of each team member on a project using
CRediT, for insertion into their manuscripts and for publishers to
potentially incorporate into article metadata.

[CRediT](https://www.casrai.org/credit.html) (Contributor Roles
Taxonomy) is a taxonomy of 14 categories of contributions to scientific
scholarly output. Each researcher can indicate which category they
contributed to in a scholarly project.
[CRediT](http://credit.niso.org/) (Contributor Roles Taxonomy) is a
taxonomy of 14 categories of contributions to scientific scholarly
output. Each researcher can indicate which category they contributed to
in a scholarly project.

The app is named after the Nepali-Indian Sherpa Tenzing Norgay, who was
one of the two individuals who reached the summit of Mount Everest for
Expand All @@ -28,14 +28,14 @@ credit than his partner, the New Zealand mountaineer Edmund Hillary.

Tenzing can:

- read all the necessary contributorship information from one file
- read all the necessary contributorship information from one file
(.csv, .tsv or .xlsx)
- create a report of the contributions
- create the contributors’ affiliation information, designed for
- create a report of the contributions
- create the contributors’ affiliation information, designed for
inclusion in the first page of a manuscript
- create JATS XML with the contributions, suitable for publishers to
- create JATS XML with the contributions, suitable for publishers to
include in metadata
- create a YAML output that will automatically add the contributorship
- create a YAML output that will automatically add the contributorship
information to the `papaja`package used by some researchers to write
APA-formatted manuscripts

Expand All @@ -45,28 +45,20 @@ Tenzing can be used either via the web app or via R.

### Using the web app

You can use the app at
<https://martonbalazskovacs.shinyapps.io/tenzing/>.
You can use the app at <https://tenzing.club/>.

You can alternatively run the app locally on your own computer by
following these instructions:

You may try to start the downlad and start the app directly in R with

```r
# install.packages ("shiny")
shiny::runGitHub("marton-balazs-kovacs/tenzing")
```

Or install the development version (tenzing is not available from CRAN)
Install the development version (tenzing is not available from CRAN)
from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("marton-balazs-kovacs/tenzing")
```

Running the app with:
Running the app.

``` r
tenzing::run_app()
Expand Down
6 changes: 4 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ reference:
news:
cran_dates: false
one_page: true

links:

home:
strip_header: true
links:
- text: Shiny app
href: http://tenzing.club/
2 changes: 1 addition & 1 deletion man/rename.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/app_use.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ knitr::opts_chunk$set(
)
```

The `tenzing` package can be used as a shiny application, which is already embedded in a webpage: [https://martonbalazskovacs.shinyapps.io/tenzing/](https://martonbalazskovacs.shinyapps.io/tenzing/). When you first open the app it might take a few seconds for the page to load.
The `tenzing` package can be used as a shiny application, which is already embedded in a webpage: [https://tenzing.club/](https://tenzing.club/). When you first open the app it might take a few seconds for the page to load.

If you want to instead run the app locally from your computer, first you have to open R and install the `tenzing` package with the following code:

Expand Down

0 comments on commit bd38b04

Please sign in to comment.