Skip to content

Commit

Permalink
Change installation instructions on README.md/.Rmd and mctq.Rmd vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
danielvartan committed May 23, 2021
1 parent 062e042 commit ee974cf
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ In case you don't feel comfortable with R, we strongly recommend checking Hadley
The first stable `mctq` version is already out, we're just waiting for the [software peer-review](https://github.com/ropensci/software-review/issues/434) to promote it to the public. We hope that it will be available on [CRAN](https://cran.r-project.org/) soon. Until that moment comes, you can install it from GitHub with:

``` {r, eval = FALSE}
# install.packages("devtools")
devtools::install_github("gipsousp/mctq", dependencies = TRUE)
# install.packages("remotes")
remotes::install_github("gipsousp/mctq", dependencies = TRUE)
```

## Usage
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ promote it to the public. We hope that it will be available on
can install it from GitHub with:

``` r
# install.packages("devtools")
devtools::install_github("gipsousp/mctq", dependencies = TRUE)
# install.packages("remotes")
remotes::install_github("gipsousp/mctq", dependencies = TRUE)
```

## Usage
Expand Down
9 changes: 4 additions & 5 deletions vignettes/mctq.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ It's a good idea to have the standard MCTQ questionnaire open while reading this

Let's start with the basics. The first thing you must do to use `mctq` is to have some MCTQ data and `mctq` installed and loaded.

To install a GitHub package you're going to need the [devtools](https://devtools.r-lib.org/) package. If you don't already have it installed, just type the following command in your console.
To install a GitHub package you're going to need the [remotes](https://remotes.r-lib.org/) package. If you don't already have it installed, just type the following command in your console.

```{r, eval = FALSE}
install.packages("devtools")
install.packages("remotes")
```

After `devtools` is installed, install `mctq` with:

```{r, eval = FALSE}
devtools::install_github("gipsousp/mctq", dependencies = TRUE)
remotes::install_github("gipsousp/mctq", dependencies = TRUE)
```

Great! We now must load the package to memory to start using it. Do this with:
Expand Down Expand Up @@ -101,7 +101,7 @@ Note that you can always convert your data back to the original format if you wa
You can also use `convert()` to convert data frame columns directly. That's what we're going to do with our data.

```{r, warnings = FALSE, message = FALSE}
library(magrittr)
library(dplyr)
data <- data %>%
convert("integer", cols = c("id", "wd"), quiet = TRUE) %>%
Expand Down Expand Up @@ -141,7 +141,6 @@ The output must be the total of free days a subject has in a week.
data$fd <- fd(data$wd)
# Comparing the result
library(dplyr)
data %>% dplyr::select(wd, fd)
```

Expand Down

0 comments on commit ee974cf

Please sign in to comment.