In KWB-R/fakin.doc: Does not matter.

FAQs {#faq}

Naming {-}

Why is the space character not allowed? {-#faq-why-no-space}

Why is the space character not allowed in file or folder names?

File paths containing spaces need to be put into quotes when being used in a command line, such as in:

"C:\Programs\model software xyz\run.exe" "\\server\path with space\input.txt"

With all paths lacking the space character you can omit the quotes:

C:\Programs\model-software-xyz\run.exe \\server\path-without-space\input.txt

Consequent usage of paths without spaces allows for simpler programming and leads to less errors during program execution.

Why are special characters not allowed in file or folder names? {-#faq-why-no-german-specials}

The way in which special characters are encoded may differ from system to system, especially between systems with different language settings. File names containing German special characters are e.g. not shown correctly on a French computer and vice versa.

Excluding (e.g. language-specific) special characters from the set of allowed characters in file or folder names avoids problems when exchanging files between partners in different countries.

We may have a problem with a file from Sofia, called

Example file from Canasoft жк. Хаджи Димитър, ул.Клисура_Troncons.xml

and they may have a problem with a file from us, called

abgebrochene schmuz- und regenwasserhaltungen schützenstraße nord 2. ba.xls

RDM Tools {-}

A very exhaustive overview of tools used in the researchers workflow are provided byr citet(manual["Bosman_2018"])`, which are grouped according to different research phases as shown below.

``{block2 type = "rmdtip"} An overview of tools used in FAKIN (including links to people at KWB who know these) is available in the projects knowledge repo at: https://kwb-r.gitlab.io/fakin/#tool

## Writing More Robust R Code {-}

For details on making R code more robust to work on different computers
please read the following [tutorial](file:///Y:/Z-Exchange/_Tutorials/HomeDirectory.html).
<!-- Only adds more details in case of html output as 
defined in "R/add_text.R" -->
`r add_text_links()`

Recommended literature: 

- [Good enough practices in scientific computing](https://doi.org/10.1371/journal.pcbi.1005510) `r citep("10.1371/journal.pcbi.1005510")`

- [Ten simple rules for making research software more robust](https://doi.org/10.1371/journal.pcbi.1005412) 
`r citep("10.1371/journal.pcbi.1005412")`

- R programming books (freely available online!)

    + [R for data science](http://r4ds.had.co.nz/) `r citep(manual["Grolemund_2017"])`

    + [Advanced R](http://adv-r.had.co.nz/) `r citep(manual[c("Wickham_2014","Wickham_2018")])`

    + [R packages](http://r-pkgs.had.co.nz/) `r citep(manual["Wickham_2015"])`

## Learning R on DataCamp {-}

Since June 2017 we have an account for the online learning platform 
[DataCamp](https://www.datacamp.com).
This platform provides many online courses in the programming language 
[R](https://cran.r-project.org/) that we use a lot at our institute. 
The usage of DataCamp allows to let new students and beginners teach 
themselves in programming. This helps a lot in bringing the programming
skills within our institute up to a certain level.

As the institution "KWB" we have a 
[Free group account](https://www.datacamp.com/pricing) and a 
[Premium group account](https://www.datacamp.com/pricing). The premium
group account comprises ten seats, i.e. ten persons can work with the online 
tutorials at the same time.

**For using DataCamp at KWB the following workflow applies:**

1. Become a member in our free [R@KWB DataCamp group](https://www.datacamp.com/groups/r-kwb)
by clicking on the following [link](https://www.datacamp.com/groups/3a6e6d4a7314de1b56a33c99c457b5c7eca00f6a/invite). 
In case you do not have a [DataCamp](https://datacamp.com) account yet, please 
register yourself first by using your KWB email address. The membership in this 
group serves two purposes: on the one hand you should start on DataCamp with 
the free courses like for example [Introduction to R](https://www.datacamp.com/courses/free-introduction-to-r) 
first. On the other hand this group serves us as a kind of long term memory, to 
assess who and how frequently the DataCamp courses are used as the amount of users 
in the free group is -- in contrast to our paid premium DataCamp group -- not 
limited. 

2. If you want to do a paid DataCamp course, please contact one of our 
**DataCamp admins** (***see box below***)) who will add you to our corporate 
premium group in case there is a free seat available. Subsequently you are able 
to start any of the available premium DataCamp courses. 

3. As soon as you either do not want to or you do not have the time for a longer 
period do one of the paid DataCamp courses, please get in touch with one of our 
**DataCamp admins** (***see box below***) again, so that he can make your seat 
available for others at KWB who are interested in learning R.

```{block2 type = "rmdtip"}
**Admins for our corporate premium group on DataCamp are:**

- [Nicolas Caradot](https://www.kompetenz-wasser.de/en/ueber-uns/team-2/?search-employee-grid=nicolas%20caradot)


- [Michael Rustler](https://www.kompetenz-wasser.de/en/ueber-uns/team-2/?search-employee-grid=michael%20rustler)

- [Hauke Sonnenberg](https://www.kompetenz-wasser.de/en/ueber-uns/team-2/?search-employee-grid=hauke%20sonnenberg)

Using Subversion at KWB {-}

For details on how to use Subversion at KWB please read the following tutorial r add_text_links()

Build Your Own Kwb Styled R Package {-}

For building your own R package from scratch we developed a helper R package kwb.pkgbuild (available on Github), which builds a KWB styled skeleton for your future R package.

With the help of this tool Andreas Matzinger was able to convert this R scripts on resilience within a few hours into the R package kwb.resilience which is now available on Github.

For more details on turning your own code into a R package checkout the tutorial at the package documentation website.

Recommended literature:

R packages r citep(manual["Wickham_2015"])
Advanced R r citep(manual[c("Wickham_2014","Wickham2018")])

Install KWB R Packages {-}

Most R packages developed at KWB are not only available in the intranet but are also available on Github. Please check the following website: http://kwb-r.github.io/status/ or https://github.com/KWB-R

Installation of these R packages can be performed with the following command in R(studio):

### Required to install an R package from Github 
install.packages("devtools", repos = "https://cloud.r-project.org")

### Now install your desired R package (e.g. "kwb.resilience")
remotes::install_github("kwb-r/kwb.resilience")

```{block2, type = 'rmdtip'} A more detailed installation tutorial of KWB R packages is available here: https://kwb-r.github.io/kwb.pkgbuild/articles/install.html

```

Organising Emails {-}

Here are some general tips to ensure your email remains organised in the long term University of Cambridge, 2018:

Delete emails you do not need. Remove any trivial or old messages from your inbox and sent items on a regular (ideally daily) basis.
Use folders to store messages. Establish a structured file directory by subject, activity or project.
Separate personal emails. Set up a separate folder for these. Ideally, you should not receive any personal emails to your work email account.
Limit the use of attachments. Use alternative and more secure methods to exchange data where possible (see ‘data sharing’ for options). If attachments are used, exercise version control and save important attachments to other places, such as a network drive.

Managing References {-#endnote}

For managing reference there are plenty of tools available. A detailed overview is provided by r citep(manual["Fenner_2014"]) in the Chapter Reference Management

At KWB we use Endnote, for which an internal guideline document (KWB-EndNote-Guideline-v3.pdf, r add_text_links()) was developed. <!-- add_text_links() only adds more details in case of html output as defined in "R/add_text.R" --

r add_chapter_firefox_local_files()