Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
updating the install directions to be simpler and more streamlined
  • Loading branch information
pdwaggoner authored Oct 31, 2024
1 parent 6c9367a commit 1bded17
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,29 @@ For more on this work, see Daniels et al. (2024), https://doi.org/10.1525/elemen

Though the current code is still largely in "research code" form, users are still encouraged to engage with it.

The simplest approach is to ingest the full repo, and work from the packaged example and sample `input_data`.
To do so, the simplest approach is to clone the repo and work from the `dlq` directory.

To do so, follow these steps:
1. Set your desired directory from which to work. E.g., for your Desktop:

1. Download the latest version of this repository, which includes the entire DLQ codebase, as a zipped/compressed file:
```bash
$ cd Desktop
```

2. Clone and store `dlq` at the desired location:

```r
download.file(url = "https://github.com/Hammerling-Research-Group/dlq/archive/refs/heads/main.zip",
destfile = "~/Desktop/DLQ.zip") # change `Desktop` to anywhere you'd like
```bash
$ git clone https://github.com/Hammerling-Research-Group/dlq.git
```

2. Navigate to where the code is stored and uncompress/unzip.
3. Move into the cloned `placement` directory:

3. Go into the unzipped folder and open `DLQ.Rproj` by double clicking it. This should open a new RStudio session, with `DLQ.Rproj` set as the root.
```bash
$ cd dlq
```

4. In the session, navigate to the `Files` tab and then open the `R` subdirectory. Start by opening and running the `MAIN_1_simulate.R` script. *Note*: For details on these scripts, see the `Code Structure` section below.
Once cloned, go into the `dlq` folder and open `DLQ.Rproj` by double clicking it. This should open a new RStudio session, with `DLQ.Rproj` set as the root.

5. Then, proceed to and run the `MAIN_2_DLQ.R` script.
In the session, navigate to the `Files` tab and then open the `R` subdirectory. Start by opening and running the `MAIN_1_simulate.R` script. *Note*: For details on these scripts, see the `Code Structure` section below. Then, proceed to and run the `MAIN_2_DLQ.R` script.

## Code Structure

Expand Down

0 comments on commit 1bded17

Please sign in to comment.