Skip to content

Streamline installation instructions #190

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

Open
karawoo wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Streamline installation instructions #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d8ad52f
Add Remotes: field to DESCRIPTION
karawoo May 28, 2024
ac990af
Update documentation
karawoo May 28, 2024
b9e6326
CommutingZones is also a GitHub package
karawoo Jul 1, 2024
ddef37c
Add comma
karawoo Jul 1, 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
3 changes: 3 additions & 0 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,8 @@ RoxygenNote: 7.2.3
Suggests:
CommutingZones,
rmarkdown
Remotes:
ebenmichael/augsynth,
facebookincubator/CommutingZones
VignetteBuilder: knitr
Roxygen: list(markdown = TRUE)
4 changes: 1 addition & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@ GeoLift requires or works with:
- R version 4.0.0 or newer.

## Installing GeoLift
To install the package, first make sure that `remotes` and
`augsynth` are installed.
To install the package, first make sure that `remotes` is installed.

```
install.packages("remotes", repos='http://cran.us.r-project.org')
remotes::install_github("ebenmichael/augsynth")
```

Then, install the package from GitHub:
Expand Down
3 changes: 1 addition & 2 deletions vignettes/GeoLift_Walkthrough.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ You can install `GeoLift` from our [GitHub repository](https://github.com/facebo
```{r install, results="hide", message=F, eval=F}
## Install remotes if noy already installed
install.packages("remotes", repos = "http://cran.us.r-project.org")
## Install augsynth & GeoLift from GitHub
remotes::install_github("ebenmichael/augsynth")
## Install GeoLift from GitHub
remotes::install_github("facebookincubator/GeoLift")
```

Expand Down
8 changes: 1 addition & 7 deletions website/docs/GettingStarted/InstallingR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,7 @@ Since GeoLift is currently only available on GitHub, the `remotes` package is a
install.packages("remotes", repos='http://cran.us.r-project.org')
```

To install the package, first make sure that remotes and `augsynth` are installed.

```
remotes::install_github("ebenmichael/augsynth")
```

Finally, we can install the `GeoLift` package with the following command:
Then we can install the `GeoLift` package with the following command:

```
remotes::install_github("facebookincubator/GeoLift")
Expand Down