Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme and create English translation #12

Merged
merged 6 commits into from
Jan 27, 2022
Merged

Update readme and create English translation #12

merged 6 commits into from
Jan 27, 2022

Conversation

cuehs
Copy link

@cuehs cuehs commented Jan 13, 2022

Fix issues fix #2 #3 #5 #11
Remove references to archive
Add English translation of the readme

@cuehs
Copy link
Author

cuehs commented Jan 13, 2022

@HannesWuensche please review & merge

@HannesWuensche HannesWuensche added the documentation Improvements or additions to documentation label Jan 14, 2022
HannesWuensche
HannesWuensche reviewed Jan 14, 2022
View reviewed changes
Readme.md Outdated

Die SARS-CoV-2-Sequenzdaten werden tagesaktuell im Hauptverzeichnis unter "SARS-CoV-2-Sequenzdaten_Deutschland.fasta.xz" bereitgestellt. Gleiches gilt für zugehörigen Metadaten, die unter "SARS-CoV-2-Sequenzdaten_Deutschland.csv.xz" und die Entwicklungslinien die unter "SARS-CoV-2-Entwicklungslinien_Deutschland.csv.xz" im Datensatz enthalten sind. **Nicht für alle SARS-CoV-2-Sequenzdaten liegen Entwicklungslinien vor.**

>SARS-CoV-2-Sequenzdaten_Deutschland.fasta.xz
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Würde ich direkt als Links anbieten:

SARS-CoV-2-Sequenzdaten_Deutschland.fasta.xz
SARS-CoV-2-Sequenzdaten_Deutschland.csv.xz
SARS-CoV-2-Entwicklungslinien_Deutschland.csv.xz

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doppel-Space für Zeilenumbruch am Ende nicht vergessen.

Readme.md Outdated
* Sequenzdaten der übermittelten SARS-CoV-2-Genomsequenzen
* Metadaten zu den SARS-CoV-2-Genomsequenzen
* Archiv mit der Sammlung aller bisherig übermittelten SARS-CoV-2-Genomsequenzen und der entsprechenden Metadaten
* Sequenzdaten der übermittelten SARS-CoV-2-Genomsequenzen (SARS-CoV-2-Sequenzdaten_Deutschland.fasta.xz)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ist etwas kleinlich und auch Geschmackssache, finde es aber besser hier nicht die Dateinamen mit anzugeben.
Ein Link auf den Teil der Doku wo es um die Daten geht wäre aber vielleicht ein Kompromiss?

Readme.md

Weitere Informationen zu den aufgeführten Variablen finden sich in der [Anleitung zur Bereitstellung der Sequenzdaten](https://www.rki.de/DE/Content/InfAZ/N/Neuartiges_Coronavirus/DESH/Anleitung-Bereitstellung-Sequenzdaten.html?) die auch in [Kontextmaterialien](https://github.com/robert-koch-institut/SARS-CoV-2-Sequenzdaten_aus_Deutschland/tree/master/Kontextmaterialien) hinterlegt ist.

### Variablen und Variablenausprägungen Entwicklungslinien
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ich würde vorschlagen die Pangolin Documentation der Variablen hier explizit auszuschreiben. Ist zwar nervig, aber wenn der Link sich ändert, dann geht die Information verloren. dass sollten wir vermeiden.

readme_en.md Outdated

>[Kontextmaterialien/2021-02-18_DESH_Anleitung_zur_Bereitstellung_Sequenzdaten.pdf](https://github.com/robert-koch-institut/SARS-CoV-2-Sequenzdaten_aus_Deutschland/blob/master/Kontextmaterialien/2021-02-18_DESH_Anleitung_zur_Bereitstellung_Sequenzdaten.pdf)
>[Kontextmaterialien/2021-02-08_DESH_Qualitätsvorgaben_für_die_Sequenzdaten.pdf](https://github.com/robert-koch-institut/SARS-CoV-2-Sequenzdaten_aus_Deutschland/blob/master/Kontextmaterialien/2021-02-08_DESH_Qualitätsvorgaben_für_die_Sequenzdaten.pdf)
>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

">" zu viel

readme_en.md Outdated

The dataset contains data on SARS-CoV-2 sequences in Germany and the contextual materials supporting the data processing. Included in the dataset are:

* Sequence data of the submitted SARS-CoV-2 genome sequences (SARS-CoV-2-Sequenzdaten_Deutschland.fasta.xz)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Siehe deutsche Doku

readme_en.md Outdated

For more information on the listed variables, see [Instructions for Providing Sequence Data](https://www.rki.de/DE/Content/InfAZ/N/Neuartiges_Coronavirus/DESH/Anleitung-Bereitstellung-Sequenzdaten.html?) which is also deposited in [Kontextmaterialien](https://github.com/robert-koch-institut/SARS-CoV-2-Sequenzdaten_aus_Deutschland/tree/master/Kontextmaterialien).

### Variables and variable expressions development lines.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Development Lines oder Lineages?

@cuehs
Copy link
Author

cuehs commented Jan 17, 2022

Hi @HannesWuensche

ich habe dein Feedback umgesetzt.
Zum Thema Pango Lineages: Die Felder und deren Beschreibung werden ab und zu geupdated. Wenn wir das hier hin kopieren müssen wir dafür sorgen, dass es regelmäßig bei uns aktualisiert wird. Außerdem haben wir dann das Problem, dass zwei sources of truth existieren (das git und die pango website). Ein Möglicher Vorschlag wäre die Daten mit zu übernehmen aber dazuzu schreiben, dass sie diese möglicherweise nicht aktuell/korrekt ist. Was meinst du?

@HannesWuensche
Copy link
Contributor

Hallo @cuehs

finde ich einen guten Vorschlag: Also den aktuellen Zustand dokumentieren, die Seite aber verlinken, mit dem Hinweis, dass, wenn unsere Doku nicht zutrifft, es möglicherweise ein Update gab, siehe Pangolin-Link.

@cuehs
Copy link
Author

cuehs commented Jan 26, 2022

Hi @HannesWuensche

ich habe die gewünschte Tabelle erstellt.

@HannesWuensche HannesWuensche merged commit 763d13c into master Jan 27, 2022
@HannesWuensche HannesWuensche deleted the doc/2_3_5_11 branch January 27, 2022 08:42
@HannesWuensche
Copy link
Contributor

Danke @cuehs!

This was referenced Jan 27, 2022
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HannesWuensche HannesWuensche HannesWuensche left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

About 10k sequences miss pango calls in "Entwicklungslinien"
2 participants
@cuehs @HannesWuensche