steps.Rmd

---
title: "Step-by-step instruction"
output:
  html_document:
    fig_cap: yes
    highlight: tango
    smooth_scroll: no
    theme: flatly
    toc: yes
    toc_float: yes
---

On this page you can find a brief step-by-step instruction on how to collect data according to the TALD methodology.

-----------

## Step 1 - Create a folder

* Make a folder for your feature in [the features' folder](https://drive.google.com/drive/u/2/folders/1Rrm0NOH2E7dGMC97TdCFhjg7Y_FrAU3i).

-----------

## Step 2 - Add data

* Copy [the feature template](https://docs.google.com/spreadsheets/d/1HCoEBiz8A2Vd9LUApRLtMANpnsUJN-k6EaXrBYfN0IU/edit#gid=0) in the folder.
 
* Collect data for each language from descriptive literature, which you can find in [our library](https://drive.google.com/drive/u/2/folders/14RBA31Cj1MsFSiV4E_ZqTLGOhI1dUfMD). Fill in all required columns (see [List of columns](datasets.html#list-of-columns) for an explanation of the column names).

* (Optional) If you want to use a source that is not in the library yet:

  + Submit information about the source via [this form](https://docs.google.com/forms/d/e/1FAIpQLSfekbCiSi5TVtJDAWcAzIajkwYyoR8WjRJ1tjkt0QS6kdkIEA/viewform?usp=sf_link). Each source should be assigned a **bibtexkey** -- a unique identifier that allows us to easily cite sources across the Atlas. See [Adding new literature](datasets.html#adding-new-literature) on how to construct a key. Be sure to check whether the key is already taken.
  
  + Upload the source to the appropriate folder in [the library](https://drive.google.com/drive/u/2/folders/14RBA31Cj1MsFSiV4E_ZqTLGOhI1dUfMD). Use the **bibtexkey** as a filename.

See [Datasets](datasets.html) for more detailed guidelines.
 
-----------

## Step 3 - Write a chapter

* Write an introductory chapter about your feature in `rmarkdown` using our [chapter template](chapter_template/chapter_template.Rmd) and [the cheat sheet](chapter_template/chapter_cheatsheet.Rmd). 

* Compile your own list of references using this [table template](https://drive.google.com/file/d/17QIK00DNzD5OoKNnlPoICryb9Ochj1X1/view?usp=sharing). 

See [Chapter](chapters.html) for more detailed guidelines.

------------

## Step 4 - Check your files

* Check that by the end of the work, your folder in [the archive](https://drive.google.com/drive/u/2/folders/1Rrm0NOH2E7dGMC97TdCFhjg7Y_FrAU3i) contains the following things:

  + your feature table in `.tsv`, with the name of your feature in lower case as filename: `YOUR_FEATURE.tsv`
  + your chapter text in `.Rmd` format (optionally a draft version in `.doc` format), with the name of your feature in lower case as filename: `YOUR_FEATURE.Rmd`
  + a table in `.tsv` format with references used in your text, with the name of your feature in lower case as filename: `YOUR_FEATURE_bib.tsv`
  
* **Make sure the filenames of your feature table, text, and references are the same**, e.g. `evidentialty_tense.tsv` (data), `evidentiality_tense.Rmd` (text), `evidentiality_tense_bib.tsv` (chapter references) 

* **Don't forget** to add the date on which you submit your finished work to us in the **date** column of your feature table!

------------

## Step 5 (Optional) - Changes after publication

What to do if you want to make changes to your data or chapter after it has been published?

* Create an issue on the [TALD Github](https://github.com/LingConLab/TALD/issues) where you outline the proposed changes.

* Please mention the title of your chapter in the subject line, and indicate whether you are the author (other users can also propose changes, and we might not be able to recognize you from your Github username).

* You will be contacted by an editor to discuss how to proceed. The process will differ depending on what and how much you want to change.

* You can also contact the Atlas (cauatlas@gmail.com) or your responsible editor directly.