You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,21 @@
2
2
3
3
1. Get the 'CodeClanData' repo from CodeClan's GitHub.
4
4
5
-
2. Go to the file `prep_data.R` inside `data-raw`.
5
+
2. Go to the file `data_raw/prep_data.R`.
6
6
7
-
3. Define your dataset in this file. This can be as simple as reading a CSV file, or you might want to do a lot of cleaning or API calls. You can see some examples in this folder. You can store raw data files in the data folder inside data-raw.
7
+
3. Define your dataset in this file. This can be as simple as reading a CSV file (put raw files in `data_raw/data`), or you might want to do a lot of cleaning or API calls. You can see some examples in this folder. You can store raw data files in the data folder inside data-raw.
8
8
9
9
*Note: we can't use files greater than 100MB on GitHub*
10
+
*Note: try to put the code in the correct place alphabetically so it's easy to find later.*
10
11
11
-
4. Once you've created your dataset, run the function `use_data`with your chosen data (see examples at the end of `prep_data.R`).
12
+
4. Once you've created your dataset, add a `use_data`function for your chosen data (see examples at the end of `prep_data.R`).
12
13
13
-
5.Now go to `documentation.R` in the R folder. Here you write a short description of your dataset, which will be shown in the documentation. See examples from the other datasets.
14
+
5.Run the whole of `prep_data.R`.
14
15
15
-
6.Use `devtools::document()`in the console.
16
+
6.Now go to `R/documentation.R`. Here you write a short description of your dataset, which will be shown in the documentation. See examples from the other datasets.
16
17
17
-
7.Push changes to GitHub.
18
+
7.Use `devtools::document()` in the console.
18
19
19
-
8. Reinstall the package on your machine using `devtools::install_github('codeclan/CodeClanData')`
20
+
8. Push changes to GitHub.
21
+
22
+
9. Reinstall the package on your machine using `devtools::install_github('codeclan/CodeClanData')`
0 commit comments