From d1e1aef4dff6434b0283d9eb9338a07ccda8162e Mon Sep 17 00:00:00 2001 From: "Languillaume, Antoine" <antoine.languillaume@wur.nl> Date: Mon, 12 Oct 2020 14:42:58 +0200 Subject: [PATCH] Update README --- README.md | 16 ++++++++++++++++ README.txt | 13 ------------- 2 files changed, 16 insertions(+), 13 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..6d86785 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# PPS Data Management Example + +This gitlab repository contains an example R project to set up a reproducible analysis as detailed in PPS [Data Management Plan] (https://phd.pps.wur.nl/sites/default/files/PPS_Data_Management%20v3.0_1.pd). + +To download it on your computer: + +1. Make an empty directory. + +2. Set it as working directory in R. + +3. Paste the following command in your terminal: + +``` r +source("https://git.wageningenur.nl/langu001/PPS_data_management/-/raw/refactor/download_project.R") +``` + diff --git a/README.txt b/README.txt deleted file mode 100644 index d9de25b..0000000 --- a/README.txt +++ /dev/null @@ -1,13 +0,0 @@ -# Data management script - -The R script "Master_Script.R" has been developed to automate the creation of part of the PPS standard data management structure. described above. Briefly, it will create the required directory structure, read any raw data files (.csv or .xlsx) stored in the project directory and place them in the data/raw directory. - -It will process the raw data into a corresponding processed .xslx file, containing 1. a meta-data worksheet with all required fields and 2. A list of all variables in the data with appropriate units if supplied and extra columns for variable definitions and privacy sensitivity. - -To use this script follow the following steps: - -1. Create a main directory and place the script and any raw data files (in .csv or .xlsx format) inside. - -2. Open R, set the working directory to the main directory and run/source the script - -An example data file: "example_data.csv", is distributed with this script and can be used for testing. More details on PPS' data management guidelines can be found in the "Documentation.docx" document. -- GitLab