{"id":13715948,"url":"https://github.com/jaeyk/makereproducible","last_synced_at":"2025-05-07T05:31:51.521Z","repository":{"id":109681678,"uuid":"269761719","full_name":"jaeyk/makereproducible","owner":"jaeyk","description":"R package for making a project computationally reproducible before sharing it","archived":false,"fork":false,"pushed_at":"2020-10-10T23:25:45.000Z","size":69,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-14T04:34:33.382Z","etag":null,"topics":["here","r","reproducibility","transparency"],"latest_commit_sha":null,"homepage":"https://jaeyk.github.io/makereproducible/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaeyk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-06-05T20:03:26.000Z","updated_at":"2020-10-10T23:25:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"c58ab54b-2446-4018-86a1-3c82261ad483","html_url":"https://github.com/jaeyk/makereproducible","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaeyk%2Fmakereproducible","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaeyk%2Fmakereproducible/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaeyk%2Fmakereproducible/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaeyk%2Fmakereproducible/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaeyk","download_url":"https://codeload.github.com/jaeyk/makereproducible/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823027,"owners_count":21809700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["here","r","reproducibility","transparency"],"created_at":"2024-08-03T00:01:05.379Z","updated_at":"2025-05-07T05:31:46.504Z","avatar_url":"https://github.com/jaeyk.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"\n# makereproducible\n\nAn R Package for Making a Project Computationally Reproducible Before Sharing it\n\nAuthor: [Jae Yeon Kim](https://jaeyk.github.io/)\n\nFile an [issue](https://github.com/jaeyk/makereproducible/issues) if you have problems, questions or suggestions.\n\n## Installation\n\n```r\n\n## Install the current development version from GitHub\n\ndevtools::install_github(\"jaeyk/makereproducible\",\n        dependencies = TRUE)\n\nlibrary(makereproducible)\n```\n\n## Usage\n\n### `make_here`\n\n[Creating self-contained projects is great](https://swcarpentry.github.io/r-novice-gapminder/02-project-intro/) to increase research reproducibility and make your life easier. To make a project self-contained, one of the things you need to do is [**STOP** using `setwd()` and **START** using alternatives like `here()`](https://github.com/jennybc/here_here). The problem is people, including, and especially me, are lazy. We know the best practice, but we don't follow it.\n\nThe `make_here()` function nudges you to make your project self-contained before sharing it with other people. It does this by saving typing time to turn [the relative or absolute path](https://r4ds.had.co.nz/workflow-projects.html) in your R code into the arguments in the `here()` function.\n\nTo learn how to use it, see the examples below.\n\n1. Not self-contained because this absolute path only works in my laptop! (**BAD**)\n\n```r\n\nread_csv(\"/home/jae/validating-two-linked-fates/raw_data/sub-data.txt\")\n```\n\n2. Voila! Now, the project is self-contained. (**GOOD**)\n\n```r\n\nread_csv(make_here(\"/home/jae/validating-two-linked-fates/raw_data/sub-data.txt\"))\n```\n\n## Instructions\n\n**Only two conditions** are needed to make the `make_here()` function work.\n\n- I assume that you created a main directory for your project (e.g., `foo`) and divided different types of files into different subdirectories (`data`, `R`, etc.).\n- I assume that you did [one of the followings](https://github.com/jennybc/here_here#the-fine-print) required by `here` package:\n  - Had a checkout from a version control system like Git. (e.g., You have a subdirectory named `.git`.)\n  - [Made your project an RStudio project.](https://r4ds.had.co.nz/workflow-projects.html) (**strongly recommended**)\n  - Put an empty file named `.here` in the main project directory (**minimal effort**).\n- `here::dr_here()` helps to check whether these two conditions were met. If setup correclty, you should be able to see something like the following: `here() starts at [your main project directory], because it [satisfies one of the conditions listed above].`\n\n## How to cite\n\nIf you would like to cite, please do something like the following:\n\n```\nJae Yeon Kim. (2020). makereproducible. R package version 0.1.0. Retrieved from https://github.com/jaeyk/makereproducible\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaeyk%2Fmakereproducible","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaeyk%2Fmakereproducible","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaeyk%2Fmakereproducible/lists"}