From e6efb08eba017664dc510d2dfcef5a64446ad2ca Mon Sep 17 00:00:00 2001 From: Edouard-Legoupil Date: Sun, 23 Jun 2019 16:02:19 +0300 Subject: [PATCH] Rev documentation --- DESCRIPTION | 2 +- README.md | 2 +- docs/articles/Getting_data.html | 8 ++++---- docs/index.html | 6 +++--- docs/reference/format_si.html | 2 +- vignettes/Getting_data.Rmd | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 227da41..0c8921e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: koboloadeR Type: Package -Title: Survey Data Crunching +Title: A metapackage for Survey Data Crunching Version: 0.1.6 Authors@R: c(person("Edouard", "Legoupil", role = c("aut", "cre"), email = "legoupil@unhcr.org"), person("Maher", "Daoud", role = "aut", email = "daoudma@unhcr.org"), diff --git a/README.md b/README.md index 04bc430..f1b3901 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ This package first builds on the capacity of UNHCR Kobo server @ http://kobo.unh The package comes as a companion tool to the [Integrated Framework for Household Survey](https://unhcr.github.io/Integrated-framework-household-survey). -koboloadeR aims at helping [humanitarian data analysts](https://humanitarian-user-group.github.io/) to save time by quickly generating graphs and charts needed to discover insights from a dataset and ensure analysis __reproducibility__ through a separation of the analysis configuration and the analysis process. The package allows to account for sample weights and hierachical dataset structure (both capacities that are not available through the defaults reporting engine or the [excel-analyzer](http://support.kobotoolbox.org/articles/592387-using-the-excel-analyzer)). +koboloadeR aims at helping [humanitarian data analysts](https://humanitarian-user-group.github.io/) to save time by quickly generating graphs and charts needed to discover insights from a dataset and ensure analysis __reproducibility__ through a separation of the analysis configuration and the analysis process. The package allows to account for sample weights and hierachical dataset structure (both capacities that are not available through the default [reporting engine](http://support.kobotoolbox.org/articles/2847676-viewing-and-creating-custom-reports) or the [excel-analyzer](http://support.kobotoolbox.org/articles/592387-using-the-excel-analyzer)). This metapackage brings together a series of specialised packages in an organised data analysis workflow. ## Approach diff --git a/docs/articles/Getting_data.html b/docs/articles/Getting_data.html index b7a7c9d..fb8c722 100644 --- a/docs/articles/Getting_data.html +++ b/docs/articles/Getting_data.html @@ -118,15 +118,15 @@

2019-06-23

The initial step to start your project is to get your data.

The package is using only csv files. this is to avoid the limitations linked the number of columns that some version of excel can handle.

-
+

-Case 1: You have only the data but not the orginal xslform

+Case 1: You have only the data but not the original xslform

In case, you have simple dataframe, you may load your data in R and then use the function kobo_to_xlsform()

MainDataFrame <- read.csv("data/MainDataFrame.csv")
 kobo_to_xlsform(MainDataFrame)

Note that this function will expect the dataframe headers contains variable names (not labels).

-

The function will build an xslform file and save it under the data folder. You can then manually edit this file ofr instance to add the label for your questions.

+

The function will build an xslform file and save it under the data folder. You can then manually edit this file for instance to add the label for your questions.

@@ -233,7 +233,7 @@

Contents