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.

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

Calibrating Radiocarbon Dates with R (translation from french) #603

Open
hawc2 opened this issue Mar 19, 2024 · 37 comments
Open

Calibrating Radiocarbon Dates with R (translation from french) #603

hawc2 opened this issue Mar 19, 2024 · 37 comments

Comments

@hawc2
Copy link
Collaborator

hawc2 commented Mar 19, 2024

Programming Historian in English has received a proposal for a translation from French: 'Calibrating carbon ages in R' by @ChristinaDNguyen.

I have circulated this proposal for feedback within the English team. We have considered this proposal for:

  • Openness: we advocate for use of open source software, open programming languages and open datasets
  • Global access: we serve a readership working with different operating systems and varying computational resources
  • Multilingualism: we celebrate methodologies and tools that can be applied or adapted for use in multilingual research-contexts
  • Sustainability: we're committed to publishing learning resources that can remain useful beyond present-day graphical user interfaces and current software versions

**We are pleased to have invited @torontoyyz to develop this Proposal into a Submission under the guidance of @lachapot and @digitalkosovski.

The Submission package should include:

  • Lesson text (written in Markdown)
  • Figures: images / plots / graphs (if using)
  • Data assets: codebooks, sample dataset (if using)

We ask @torontoyyz to share their Submission package with our Publishing team by email, copying in the editors.

We've agreed a submission date of early April. We ask @torontoyyz to contact us if they need to revise this deadline.

When the Submission package is received, our Publishing team will process the new lesson materials, and prepare a Preview of the initial draft. They will post a comment in this Issue to provide the locations of all key files, as well as a link to the Preview where contributors can read the lesson as the draft progresses.

If we have not received the Submission package by April, @lachapot will attempt to contact @torontoyyz. If we do not receive any update, this Issue will be closed.

Our dedicated Ombudspersons are Ian Milligan (English), Silvia Gutiérrez De la Torre (español), Hélène Huet (français), and Luis Ferla (português) Please feel free to contact them at any time if you have concerns that you would like addressed by an impartial observer. Contacting the ombudspersons will have no impact on the outcome of any peer review.

@ChristinaDNguyen
Copy link
Collaborator

Hooray! Here's the initial translation in plain R - it's not in Markdown yet, but that's coming. Figures and table images are also in this zip.

Thanks for being patient and supportive!
initial-translation-without-markdown.zip

@anisa-hawes anisa-hawes moved this from 0 Proposal to 1 Submission in Active Lessons May 1, 2024
@anisa-hawes
Copy link
Contributor

Hello Christina @TorontoYYZ,

Many thanks for sharing your submission materials with us. @charlottejmc and I are happy to set up the file as Markdown for you, so we'll take it from here!

When we've processed your materials, we'll post a comment here in the Issue to the share locations of all the key files.

Very best wishes for now,
Anisa

@charlottejmc
Copy link
Collaborator

charlottejmc commented May 2, 2024

Hello @digitalkosovski, @lachapot and @TorontoYYZ,

You can find the key files here:

You can review a preview of the lesson here:


I noticed a couple things while processing this submission, which I've outlined below:

  • I wonder whether you'd like to choose between either 'Calibrating carbon ages in R' or 'Calibrating Radiocarbon Dates with R'. Currently, both translations are used interchangeably, but I feel it would be clearer to keep to one of these phrases only.
  • You'll see that I've set up the images using our liquid syntax format : {% include figure.html filename="file-name-1.png" alt="Visual description of figure image" caption="Figure 1. Caption text to display" %}. In most cases, you had provided a caption, which I was able to fill in. However,
    - Figure 8 was missing its caption. I've left the French caption as a placeholder, but I'll leave it to you to translate it to English!
    - All of the figures now also need alt-text – a visual description of the image for visually impaired readers
    - You noted that Figure 7 was missing Samples 2 and 3 – let me know when this image is ready, and I can add it in for you
  • Endnotes have not been carried over from the FR version yet. If you're planning to use all the same references, I'm happy to do this myself
  • Hyperlinks have also not been carried over from the FR version. Again, if you're planning to replicate them exactly, I can add them in myself
  • I noticed the lesson abstract and 'avatar alt' still need to be translated. I've left the FR versions in the YAML header, which you'll be able to translate/adapt as needed.
  • I carried over all the mathematical notation from the FR lesson. We use a specific format for these (for example, σ is \\(\sigma\\)). This also means you don't need to add images for the longer equations, as I've already embedded them in the text.
  • I replaced the Table 1 image with a markdown table, to help keep the page as light as possible

Thank you very much for your patience and your work!

@anisa-hawes anisa-hawes moved this from 1 Submission to 2 Initial Edit in Active Lessons May 2, 2024
@anisa-hawes
Copy link
Contributor

Hello Christina @TorontoYYZ,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 2: Initial Edit.

In this Phase, your editors Laura @lachapot and Agustín @digitalkosovski will read your translation, and provide some initial feedback. They'll post feedback and suggestions as a comment in this Issue, so that you can revise your draft in the following Phase 3: Revision 1.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#882b4f', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 1 <br> Submission
Who worked on this? : Publishing Assistant (@charlottejmc) 
All  Phase 1 tasks completed? : Yes
Section Phase 2 <br> Initial Edit
Who's working on this? : Editors (@lachapot + @digitalkosovski)  
Expected completion date? : June 3
Section Phase 3 <br> Revision 1
Who's responsible? : Translator (@TorontoYYZ) 
Expected timeframe? : ~30 days after feedback is received
Loading

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

@anisa-hawes
Copy link
Contributor

anisa-hawes commented May 2, 2024

Hello again @TorontoYYZ,

In the meantime, I've invited you to join us here on GitHub as an Outside Collaborator. This will give you the Write access you'll need to edit your lesson directly. Charlotte has shared some notes above about a few components that are still needed / details that we'd like to help clarify.

The French original lesson was published before we introduced alt-text for all figures, so I realise that you don't have the original alt-text available to translate. For writing the alt-text, this resource may be useful. It advises that the alt-text for graphs and data visualisations should consist of the following:

alt="Chart type of data type where reason for including chart"

You can either add the alt-text into the templates Charlotte created, or leave a comment here in the Issue and we will add it in for you.

Thank you,
Anisa

@lachapot
Copy link

lachapot commented May 3, 2024

Hi everyone,

Thank you very much for your translation, @TorontoYYZ . And thank you @charlottejmc and @anisa-hawes for setting it all up! We'll be back in touch with some initial feedback in the next couple of weeks.

Thank you,
Laura

@ChristinaDNguyen
Copy link
Collaborator

Hello again @TorontoYYZ,

In the meantime, I've invited you to join us here on GitHub as an Outside Collaborator. This will give you the Write access you'll need to edit your lesson directly. Charlotte has shared some notes above about a few components that are still needed / details that we'd like to help clarify.

The French original lesson was published before we introduced alt-text for all figures, so I realise that you don't have the original alt-text available to translate. For writing the alt-text, this resource may be useful. It advises that the alt-text for graphs and data visualisations should consist of the following:

alt="Chart type of data type where reason for including chart"

You can either add the alt-text into the templates Charlotte created, or leave a comment here in the Issue and we will add it in for you.

Thank you, Anisa

Thank you for clarifying, Anisa. Could you add the alt-text in for me, please?

Thank you,
Christina.

@ChristinaDNguyen
Copy link
Collaborator

ChristinaDNguyen commented May 6, 2024

I noticed a couple things while processing this submission, which I've outlined below:

  • I wonder whether you'd like to choose between either 'Calibrating carbon ages in R' or 'Calibrating Radiocarbon Dates with R'. Currently, both translations are used interchangeably, but I feel it would be clearer to keep to one of these phrases only.

C: Thank you for noticing! Let's change all the variants to 'radiocarbon date'/'radiocarbon dating' to be specific. That is, 'carbon ages,' 'carbon dates,' 'radiocarbon ages' should all change.

  • You'll see that I've set up the images using our liquid syntax format : {% include figure.html filename="file-name-1.png" alt="Visual description of figure image" caption="Figure 1. Caption text to display" %}. In most cases, you had provided a caption, which I was able to fill in. However,
    • Figure 8 was missing its caption. I've left the French caption as a placeholder, but I'll leave it to you to translate it to English!

C: Sorry about that, and thank you for explaining what you did - here's the translation for the caption. "Distribution of conventional and calendar dates of the mean ages of samples 2, 3 and 4. The dark gray areas correspond to the 95% HPD interval. IntCal20 calibration curve." I have included this in the .txt file linked in the next comment.

  • All of the figures now also need alt-text – a visual description of the image for visually impaired readers

C: alt text for all figures are in this .txt file, thank you:

alt-text-tables-and-figs.txt

  • You noted that Figure 7 was missing Samples 2 and 3 – let me know when this image is ready, and I can add it in for you

C: thank you, working on this now and will update when done.

  • Endnotes have not been carried over from the FR version yet. If you're planning to use all the same references, I'm happy to do this myself

Could you please do this for me? Thank you very, very, very much! Do carry them over.

  • Hyperlinks have also not been carried over from the FR version. Again, if you're planning to replicate them exactly, I can add them in myself

C: Yes, could you replicate the hyperlinks exactly? Thank you again.

  • I noticed the lesson abstract and 'avatar alt' still need to be translated. I've left the FR versions in the YAML header, which you'll be able to translate/adapt as needed.

C: thank you, and my apologies. The translation for the lesson abstract is here. What did you mean by 'avatar alt'?

abstract.txt

  • I carried over all the mathematical notation from the FR lesson. We use a specific format for these (for example, σ is \\(\sigma\\)). This also means you don't need to add images for the longer equations, as I've already embedded them in the text.

C: you're a lifesaver, thank you very much! again!

  • I replaced the Table 1 image with a markdown table, to help keep the page as light as possible

Amazing, thank you! This looks much lighter, you are right of course

Thank you very much for your patience and your work!

C: genuinely, thank _you _ for editing my work! It looks much better already...

@anisa-hawes
Copy link
Contributor

anisa-hawes commented May 8, 2024

Hello Christina @TorontoYYZ,

I think I wasn't clear in my previous note about what is required for the alt-text element. We're happy to slot in the text for you, but we do need you to draft the descriptions. It's important to say that alt-text should go further than repeating the figure captions -- this is about opening up the visuals to people who use screen-readers.

I shared Amy Cesal's guide to Writing Alt Text for Data Visualization because I think Cesal's 'formula' for describing graphs could be useful. What I think Amy Cesal's guide achieves which is important, is prompting an author/translator to reflect on the reasons for including the graph or visualisation. What idea does this support? What can a reader learn or understand from this visual?

Another resource I've found useful is the Graphs section of Diagram Center's guidance. I think some key points (relevant to all graph types) we could take away from it are:

  • Briefly describe the graph and give a summary if one is immediately apparent
  • Provide any titles and axis labels
  • It is not necessary to describe the visual attributes of the graph (colour, shading, line-style etc.) unless there is an explicit need
  • Often, data shown in a graph can be converted into accessible tables

Following those prompts, (keeping in mind that my absolute novice reading of this line graph is likely lacking) for Figure 1 you might write:

alt="Line graph showing the exponential decay of radioactive atoms over time. The x-axis is labelled Number of Atoms, while the y-axis is labelled Time (half-lives). From a high upper point, the line curves steeply indicating that after two radioactive periods, the number of atoms has reduced to a quarter of the original quantity."

Would you feel comfortable making a first draft of the alt-text for each of the figures? I know this is a bit time-consuming, but I do think it is very worthwhile in terms of making your translation accessible to the broadest possible audience. We would be very grateful for your support with this.


The avatar_alt which Charlotte mentions above is simply the alt-text description of the thumbnail image which represents the lesson (found at upper left of the header ribbon). The original author wrote the following in French to describe the image: Vases, meubles et sujets divers peints dans les tombeaux des rois so we are just asking for your English translation of that.

Thank you,
Anisa

@ChristinaDNguyen
Copy link
Collaborator

Thank you for clarifying Anisa, I'm sorry for not understanding before. This is a good exercise to do. Here is the alt-text.txt following Diagram Centre's guidance.

Thank you for explaining what the avatar text is. I cannot see the image very clearly, so here is the French description translated verbatim. "Vases, furniture, and various objects painted in the tombs of kings." Does it look like the word on top of that image says "Thèbes" to you? If so, we can add that to the text too.

Cheers, and thanks for your patience,
Christina

@charlottejmc
Copy link
Collaborator

charlottejmc commented May 8, 2024

Hi @TorontoYYZ,

Thank you very much for your response! I've added in the translated lesson abstract and the caption for Figure 8, as well as carried over the endnotes and hyperlinks. (Just seeing your comment above: your translation of the avatar is perfect. I'll add it in now.)

I've also renamed the lesson file and image filenames to calibrating-radiocarbon-dates-R to follow the updates title, 'Calibrating Radiocarbon Dates with R'.

  • The only thing I'll still need your input on now (on top of the alt-text – thank you @anisa-hawes for your clarification above) would be to translate the endnotes, which are still in French.

Thank you!

@charlottejmc charlottejmc changed the title Calibrating carbon ages in R (translation from french) Calibrating Radiocarbon Dates with R (translation from french) May 8, 2024
@ChristinaDNguyen
Copy link
Collaborator

ChristinaDNguyen commented May 8, 2024

Charlotte, thank you! Here's a translation of the endnotes. endnotes.docx. Endnote #11 in the French version actually has a time-dependent statement based on the time this lesson was originally published so I added this in brackets. I hope that's clear.
At the moment of this lesson’s publication (in French), the curve IntCal20 has just been published. Reimer et al., 2009, 2013, 2020.

@lachapot
Copy link

lachapot commented May 16, 2024

Thank you @TorontoYYZ, @charlottejmc, and @anisa-hawes for all the work you’ve done on this lesson translation so far. We know a lot of people would be very interested in having this lesson available in English so we’re excited that you’re undertaking this, Christina! Here is some additional feedback from @digitalkosovski and me.

The main comment we’d have is that currently the translation feels very literal, following the French nearly word for word, which often makes it hard to read and understand in English. We’d suggest that you go over the translation (without looking at the original French) and revise it to make the language clearer and more idiomatic in English — focus on how you’d want to write it in English to make it easily readable for English readers, rather than following the French so closely. We’d suggest that you pay particular attention to:

  • terminology and word choice, making sure that the most accurate words are being chosen. A recurring problem to note, for example, is that “dates” and “ages” are used seemingly interchangeably throughout. Might it be possible to be more consistent in the use of these terms? When would it be most accurate to use “ages” and “dates” in English?
  • sentence structure and syntax (often French syntax doesn’t translate well into English and requires some sentence restructuring)
  • verb forms (for example infinitives in French don’t always translate well to infinitives in English, such as in the title of the lesson: “Calibrer des âges radiocarbone” would translate more idiomatically to Calibrating Radiocarbon Dates than Calibrate Radiocarbon Dates)
  • and finally, connectors (such as “alors”, “ainsi”, ou “de fait” that don’t translate well literally. For example, “De fait” often doesn’t translate well to “In fact”).

We’ve flagged up a few specific instances below, for each section of the lesson, that would need some further attention, and we’ve sometimes provided examples of how you might reformulate, in case that’s helpful, but we leave it up to you to go through the lesson and revise how you see fit to make it clearer, more flowing and idiomatic.

N.B. When paragraph numbers are mentioned they refer to the lesson preview

The abstract

  •  In the first line of the abstract: perhaps change “guide you through” to “teach you how to” which is closer to the original and perhaps clearer?

  •   Perhaps change “how to develop the calibration with a set of dates” to “how to calibrate a set of dates” (nominalization sounds clunky in English)

  •  Syntax: delete the second “explains” (i.e. “this lesson explains step-by-step how to calibrate a set of dates, and how to explore and present the results”).

Calibrate Radiocarbon Dates with R

  •  In title update “Calibrate” to “Calibrating”

  • Paragraph 1: This is an example where French syntax is hard to follow in English. Consider restructuring the sentences and replacing “has become common use” with “has become common practice for” or “has become widely used by archaeologists and historians”. For the second sentence (though depends on how you choose to reformulate the paragraph) change to: “This is because it either constitutes the only chronological information, or it complements other sources, whether they be material or textual.” (more idiomatic and easier to follow)

  •  Paragraph 2: The last sentence is an example where connectors don’t translate well, replace with something like “Calibration is therefore an essential step (when using radiocarbon dating) that allows us to translate from the radiocarbon frame of reference to a calendar frame of reference.” (what is in between brackets is optional, can be deleted)

  •  Paragraph 3, line 1: “This lesson will show you” or “This lesson will detail/explain how to calibrate radiocarbon dates using the R language”

  •  Paragraph 3: Instead of “The use of R”, replace with “Using R allows…”

  •  Paragraph 3: Delete “the” in “understand the basic notions of statistics”.

  •  Paragraph 3: Word choice: Reservoir “effects” would be more precise than “problems”

  •  Paragraph 3: change “modelling” to “modeling” for consistency

The Principles of Carbon Dating

  •  Edit title to “Basic Principles of Radiocarbon Dating”?

  • Paragraph 4: perhaps change “The latter” to “this”. In addition, issues of word choice here “chronometer” or eventually “time frame” might be more appropriate than “timeline” in this context (review it also in the rest of the tutorial including paragraphs 5 and 16)

  •  Paragraph 5 line 1, potentially edit to: “Three necessary conditions must be met [or verified]”

  •  Paragraph 6: delete “(notée”

  •  Figure 1 caption: “over time” rather than “in relation to time” sounds more idiomatic

  •  Paragraph 10: some syntax and connector issues in this paragraph (e.g. last sentence could at least be modified to: “Thus/Therefore, the event dated by the radiocarbon is the death of the organism”)

  •  Paragraph 11, first line: The first line could be clearer, perhaps reformulate to something like: “Unless we are specifically looking for when an organism died, the radiocarbon can therefore provide a….” or “The radiocarbon can provide a terminus ante or post quem for the archaeological event that we wish to position in time (but we cannot use it if we are specifically looking for when an organism died)” or similar.

  •  Paragraph 11: italicize terminus ante and post quem

  •  Paragraph 11: word choice: replace “participate in the interpretation” with “impact the interpretation”? In addition, consider using “clear/direct/unique” instead of “univocal” (not a frequent term)

  •  Paragraph 11: replace “in particular by ensuring” with “in particular, we need to ensure"

  •  Paragraph 13: word choice: “premise” rather than “postulate”?

  •  Paragraph 13: “Libby and his colleagues”

  •  Paragraph 13, last line: Consider reformulating the last line to something like: “From these results, it appears that there is a linear relationship between the radiocarbon ages and the calendar ages obtained through other methods”

  •  Figure 2 caption: a part of the caption is missing “Âges mesurés par le radiocarbone en fonction des âges calendaires attendus.”

Why Calibrate Radiocarbon Ages?

  •  Paragraph 14: Consider reformulating this sentence. E.g. “However, studies carried out in the second half of the 20th century, as increasingly older objects were dated, highlighted an increasingly significant gap between the measured age and the expected age.” (although this isn’t a great translation because repeats “increasingly”)

  •  Paragraph 15: This paragraph could be reformulated to be less literal. As mentioned before, perhaps replace “postulate” with “premise” and replace “partly explaining the observed differences” with “which partly explains the observed differences”

  •  Paragraph 16: Review word choices and wording: “dates” or “ages”? Also perhaps “chronometer” or “timeframe” rather than “timeline”, also “pattern” or “trend” or “rate” instead of “rhythm” (cf. also paragraph 72)

  •  Paragraph 17: Replace “The use of Libby’s postulate” with “Libby’s premise”? Also part of the final sentence seems to be missing: “The calibration curve is created by dating samples using both radiocarbon dating and an independent method, which provides a conversion table between radiocarbon time and calendar time” or something similar.

How to Calibrate?

  •  Paragraph 19: First sentence unclear. “We have therefore just seen [or established] that it is necessary to calibrate radiocarbon ages”.

  •  Paragraph 19: word choice: replace “equivalence table” with “conversion table”?

  •  Paragraph 20: This reads quite literal.

  •  Paragraph 21: connector problem, replace “In fact,” with “In this way” or similar

  •  Paragraph 21: replace “it can be modeled” with “and can be modeled”

  • Paragraph 23: in the last sentence, consider breaking the sentence into two sentences. Full stop where the colon is and new sentence: “In other words, at 1σ, the range of values is narrower”

  •  Paragraph 25: replace “the calendar age interval which corresponds” with “the corresponding calendar age”

  •  Paragraph 25: replace “presents” with “shows”

  •  Paragraph 27: This reads quite literal. Replace for example “In fact, the current approach also consists of taking into account the normal distribution of radiocarbon ages.” with “Therefore, the approach widely used nowadays [or similar expression] is to also take into account the normal distribution of radiocarbon ages.”

  •  Paragraph 27: “refer to this” rather than “refer to it”.

  •  Paragraph 28: check the language in this paragraph, some mistakes and unclear (e.g. last line “a calibrated age does not can be expressed” and first line could be clearer e.g. Whilst it is easy to describe a conventional date and its uncertainty with a normal law, that is not the case for a calendar date once calibrated.)

  •  Paragraph 30: delete “both” (there seems to be three things listed)

  •  Paragraph 32: Article missing in last line? “The calendar date has a 68% chance…”?

  • Paragraph 34, first line: Perhaps start a new sentence at the comma, and “In these cases, it is recommended…”

  •  Paragraph 37, first line: I’d suggest reformulating the first line to: “It should be clear by now how these particularities [or details], if poorly understood,….” or similar

  •  Paragraph 37: second line is a bit unclear, maybe reformulate to something like: “It is therefore essential to present all the data and choices that contributed to obtaining the calendar ages when studying or publishing a dating series.” or similar

Applications with R

  •  Paragraph 39: “easily” rather than “simply”?

  •  Paragraph 40: second sentence unclear

  •  Paragraph 42: word choice: “screed” is not the right word here, it should be “cope” (a religious cloak or coat)

  •  Paragraph 44: “rcarbon” missing in first line (After installing the package rcarbon)

  •  In code block after 44, perhaps “## Install package” rather than “## package installing” for the first comment? Also second comment is not translated (## Import data)

How to Visualize the Output Data

  •  Paragraph 47: “In this case study,”?

Are the Results from Different Laboratories in Agreement?

  •  Paragraph 55: delete extra bracket in “((n is the number of datings per object, here n=3) for the 3 labs)”

  •  in code block above 57, small spelling mistake (“liste” should be “list” or should it be “collect”?)

Date Calibration

  •  Word choice: In this section (and the title of the section) it switches a lot between “age” and “data”, perhaps review to make sure right terminology is being used more consistently

How to Interpret these Dates

  •  Paragraph 61: “function” missing: “using the plot() function”

  •  Comments missing in code block below paragraph 61

How to Present your Results

  •  Paragraph 69: Perhaps reformulate first sentence: “In order to communicate [or present] or publish radiocarbon dates rigorously and to allow results to be verifiable and usable,….” or something similar

  •  Paragraph 71: word choice: should “form” be “formulation” or something similar? “form” sounds strange…

Conclusion

  •  Paragraph 72: First line, replace “The calibration of radiocarbon ages” with “Calibrating radiocarbon ages”

We hope this is helpful! Let us know if there’s anything you’d like to discuss or if you have any questions. Ideally, this first round of revisions would happen within 30 days so that we can move swiftly on to the next phase, but let us know if there are any adjustments you need to make on the timeline.

Thanks again for this exciting contribution and looking forward to working on this with you!

Laura and Agustín

@anisa-hawes
Copy link
Contributor

anisa-hawes commented May 17, 2024

Hello Christina @TorontoYYZ,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 3: Revision 1.

This phase is an opportunity for you to revise your draft in response to @lachapot and @digitalkosovski's initial feedback.

You already have the 'write access' you need to edit your draft directly.

We ask authors to work on their own files with direct commits: we prefer you don't fork our repo, or use the Pull Request system to edit in ph-submissions. You can make direct commits to your file here: /en/drafts/translations/calibrating-radiocarbon-dates-R.md. Remember @charlottejmc and I can help if you encounter any practical problems!

When you, Laura and Agustín are all happy with the revised draft, we will move forward to Phase 4: Open Peer Review.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#882b4f', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 2 <br> Initial Edit
Who worked on this? : Editors (@lachapot + @digitalkosovski) 
All  Phase 2 tasks completed? : Yes
Section Phase 3 <br> Revision 1
Who's working on this? : Author (@TorontoYYZ)  
Expected completion date? : June 30
Section Phase 4 <br> Open Peer Review
Who's responsible? : Reviewers (TBC) 
Expected timeframe? : ~60 days after request is accepted
Loading

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

@lachapot
Copy link

Hi Christina @TorontoYYZ, thank you for letting us know. June 30th sounds good to me.
Have a good break!
Laura

@ChristinaDNguyen
Copy link
Collaborator

Hi Laura and Agustín, I've committed the changes directly. Thank you very much for all the corrections; it improves the flow of the lesson considerably. I have so much respect for you who deal with coding, and translation, and technical guides all at once, and with such apparent ease!

I have left some of the very technical translations as they are, e.g. paragraph 20, as they are a step-by-step literal process. I also unfortunately couldn't tell which paragraph number refered to what in the lesson preview (probably my inability to use the GitHub interface), so these are my best guesses for the locations of corrections.

Please let me know when there are any other changes to be made, of course. I'm sorry if I missed something or misunderstood something else. Tell me if that happened!

Christina

@charlottejmc
Copy link
Collaborator

charlottejmc commented Jun 28, 2024

Hello @TorontoYYZ,

Thank you very much for all your work updating your lesson. I've gone through the changes you made and ticked them off Laura's comment above.

You'll see that certain boxes are left unchecked – I've copied them below with the line number from the markdown file, to help you see where exactly in the text they refer to:

  • In the first line of the abstract: perhaps change “guide you through” to “teach you how to” which is closer to the original and perhaps clearer? --- Line 37 --- I might suggest "After reviewing the basic principles and the challenges of radiocarbon dating, this lesson teaches you to calibrate a set of dates, then explore and present your results."
  • Edit title to “Basic Principles of Radiocarbon Dating”? --- Line 47
  • Paragraph 5 line 1, potentially edit to: “Three necessary conditions must be met [or verified]” --- Line 51
  • Paragraph 11, first line: The first line could be clearer, perhaps reformulate to something like: “Unless we are specifically looking for when an organism died, the radiocarbon can therefore provide a….” or “The radiocarbon can provide a terminus ante or post quem for the archaeological event that we wish to position in time (but we cannot use it if we are specifically looking for when an organism died)” or similar. --- Line 66
  • Paragraph 14: Consider reformulating this sentence. E.g. “However, studies carried out in the second half of the 20th century, as increasingly older objects were dated, highlighted an increasingly significant gap between the measured age and the expected age.” (although this isn’t a great translation because repeats “increasingly”) --- Line 77
  • Figure 2 caption: a part of the caption is missing “Âges mesurés par le radiocarbone en fonction des âges calendaires attendus.” --- Line 85
  • Paragraph 20: This reads quite literal. --- Line 91 --- You've explained that this needs to remain literal, as it's a very linear step-by-step section.
  • Paragraph 21: connector problem, replace “In fact,” with “In this way” or similar --- Line 93
  • Paragraph 25: replace “the calendar age interval which corresponds” with “the corresponding calendar age” --- Line 101
  • Paragraph 28: check the language in this paragraph, some mistakes and unclear (e.g. last line “a calibrated age does not can be expressed” and first line could be clearer e.g. Whilst it is easy to describe a conventional date and its uncertainty with a normal law, that is not the case for a calendar date once calibrated.) --- Line 107
  • Paragraph 30: delete “both” (there seems to be three things listed) --- Line 111
  • Paragraph 37, first line: I’d suggest reformulating the first line to: “It should be clear by now how these particularities [or details], if poorly understood,….” or similar. + The second line is a bit unclear, maybe reformulate to something like: “It is therefore essential to present all the data and choices that contributed to obtaining the calendar ages when studying or publishing a dating series.” or similar --- Line 135
  • Paragraph 39: “easily” rather than “simply”? --- Line 141
  • Paragraph 40: second sentence unclear --- Line 145
  • Paragraph 71: word choice: should “form” be “formulation” or something similar? “form” sounds strange… --- Line 475

@TorontoYYZ, perhaps you might want to have another look through these, and decide whether you still want to change anything?

I will also be copyediting and typesetting your lesson later in Phase 6 – so I'll be able to catch and edit any remaining issues.

Thanks again for your great work and your patience!

@ChristinaDNguyen
Copy link
Collaborator

Got it, I'll be on this today or tomorrow... Thanks.

@ChristinaDNguyen
Copy link
Collaborator

Thanks, I've corrected and pushed the changes now. Again thank you for picking through and providing lots of help. :)

@lachapot
Copy link

lachapot commented Jul 18, 2024

Thank you very much Christina @TorontoYYZ for your kind words and for your hard work on this lesson! And thank you Charlotte @charlottejmc for checking over the edits. We agree that it reads much better now and is nearly ready for the next stage. There are just a few small typos that we might want to address before peer-review:

We noticed there are exclamation marks in some places rather than full stops. Not sure if these are typos or stylistic choices. The exclamation marks feel a little incongruous with the overall style of the piece though so perhaps they should be changed to full stops. They are at:

  • paragraph 23, last sentence
  • paragraph 32 last sentence
  • paragraph 37 in the third line

We also think the expression “the R language” sounds a little strange in English and recommend changing it simply to “R” (as you have already done in many other parts of the lesson). These instance are at:

  •  paragraph 3, first sentence
  •  paragraph 38, third sentence (or “The programming language R” if you want to avoid repetition with the following sentence, but just using “R” would perhaps still be more idiomatic. Up to you)

Otherwise there are just a few small typos and errors:

  • paragraph 17: “the values for which is regularly”. It should be “are” instead of “is”

  •  there’s a small typo in paragraph 38, line 4: “whihc” should be “which”

  • paragraph 41 “are” should be changed to “were”

Once these have been addressed, we’ll be ready to move on to the next phase of external peer-review.

Let us know if you have any questions and thanks again for all your work on this lesson!
Laura and Agustín

@ChristinaDNguyen
Copy link
Collaborator

ChristinaDNguyen commented Jul 19, 2024

Laura and Agustín, fixed! Thanks for the help. Hooray for the next phase! I apologize for not @lachapot you when I previously posted replies.

@lachapot
Copy link

Perfect, thank you for making the edits Christina @TorontoYYZ (and no problem at all about tagging me). The lesson is ready to move on to the peer-review phase now! Anisa @anisa-hawes will provide some further details about this peer-review phase, and Agustín and I will be in touch once reviewers have been confirmed. Thanks again for all your work so far and looking forward to next steps!

@anisa-hawes anisa-hawes moved this from 3 Revision 1 to 4 Open Peer Review in Active Lessons Jul 24, 2024
@anisa-hawes
Copy link
Contributor

anisa-hawes commented Jul 24, 2024

Hello Christina @TorontoYYZ,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 4: Open Peer Review.

This phase is an opportunity for you to hear feedback from peers in the community.

Laura @lachapot and Agustín @digitalkosovski will invite two reviewers to read your translation, test the code, and provide constructive feedback. In the spirit of openness, reviews will be posted as comments in this issue (unless you specifically request a closed review).

After both reviews, Laura and Agustín will summarise the suggestions to clarify your priorities in Phase 5: Revision 2.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#882b4f', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 3 <br> Revision 1
Who worked on this? : Author (@TorontoYYZ)
All  Phase 3 tasks completed? : Yes
Section Phase 4 <br> Open Peer Review
Who's working on this? : Reviewers (@semanticnoodles + @jeffblackadar)
Expected completion date? : Oct 20 // Nov 29
Section Phase 5 <br> Revision 2
Who's responsible? : Author (@TorontoYYZ)
Expected timeframe? : ~30 days after editors' summary
Loading

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

@lachapot
Copy link

lachapot commented Sep 11, 2024

Open Peer Review

During Phases 2 and 3, we provided initial feedback on this lesson, and worked with Christina @ChristinaDNguyen to complete a first round of revisions.

In Phase 4 Open Peer Review, we invite feedback from others in our community.

Welcome Giulia Osti @semanticnoodles and Jeff Blackadar @jeffblackadar. By participating in this peer review process, you are contributing to the creation of a useful and sustainable technical resource for the whole community. Thank you.

Please read the lesson, test the code, and post your review as a comment in this issue by November 29.

@ChristinaDNguyen, please don’t make any revisions to the lesson until both reviewers have posted their reviews so that we can ensure reviewers are reviewing the same lesson. Thank you!

Reviewer Guidelines:

A preview of the lesson:

--
Notes:

  • All participants in this discussion are advised to read and be guided by our shared Code of Conduct.
  • Members of the wider community may also choose to contribute reviews.
  • All participants must adhere to our anti-harassment policy:

Anti-Harassment Policy

This is a statement of the Programming Historian's principles and sets expectations for the tone and style of all correspondence between reviewers, authors, editors, and contributors to our public forums.

Programming Historian in English is dedicated to providing an open scholarly environment that offers community participants the freedom to thoroughly scrutinize ideas, to ask questions, make suggestions, or request clarification, but also provides a harassment-free space for all contributors to the project, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age or religion, or technical experience. We do not tolerate harassment or ad hominem attacks of community participants in any form. Participants violating these rules may be expelled from the community at the discretion of the editorial board. If anyone witnesses or feels they have been the victim of the above described activity, please contact our ombudsperson Dr Ian Milligan. Thank you for helping us to create a safe space.

@semanticnoodles semanticnoodles pinned this issue Sep 25, 2024
@semanticnoodles semanticnoodles unpinned this issue Sep 25, 2024
@ChristinaDNguyen
Copy link
Collaborator

Hi, just an FYI, I updated my username to @ChristinaDNguyen instead of the TorontoYYZ. I'm not sure if you need to know this to @ me in future... Thanks.

@anisa-hawes
Copy link
Contributor

Thank you for letting us know, @ChristinaDNguyen! ☺️
Also to confirm, that your Write permissions to our ph-submissions repository carry over to your new username.

@semanticnoodles
Copy link

semanticnoodles commented Oct 2, 2024

Hello everybody!

In addition to explaining how to convert radiocarbon dates to calendar dates, the lesson describes how to use R to compare and check the consistency of radiocarbon dates obtained from different laboratories for the same objects. The analytical process and its visualisation are thoroughly explored, but quite easy to follow. I believe this translation will be highly appreciated by archaeologists around the world: I am looking forward to sharing this lesson with my ex-colleagues; Thanks for letting me take part in this review, @lachapot & @digitalkosovski!

I think @ChristinaDNguyen has done a brilliant job with the translation, given the complexity and specificity of the language used in this lesson, chapeau 🎩! I have come up with a lean (by my standards, at least) list of comments that I hope will be helpful. If you need any clarification, feel free to ping me 🌟

Clarifications & Typos

  • para 2, combining instead of combine
  • para 9, uses carbon-14 instead of 14C
  • para 12, why are bullet-points are used in this context?
  • para 15, observed instead of observerved
  • para 21 and 28, distribution instead of law (less common form)
  • para 28, once (it has been) calibrated
  • para 30, is derived from instead of results
  • para 31, HPDI becomes HPD after this first occurrence
  • para 93, I suggest pointing the reader towards Carlson, D. L. (2017). Quantitative Methods in Archaeology Using R. Cambridge: Cambridge University Press.

Coding

  • para 49: only samples 3/4 appear in the picture (missing 1 and 2).
  • para 69. I believe that modifying the graphic parameters into par(mfrow = c(1, 1), mar = c(4, 1, 3, 1) + 0.1, las = 1) gets out a figure that is more easily readable:
    Image

@lachapot
Copy link

lachapot commented Oct 2, 2024

Thank you very much for your review @semanticnoodles! We really appreciate the time and effort you put into this. @ChristinaDNguyen, could I please ask you to wait until we receive a review from our second reviewer before making any changes to the lesson so that we can ensure both reviewers are reviewing the same lesson. We're hoping to have a second reviewer secured soon, sorry for the delay and thank you for your patience!

@lachapot
Copy link

Hi @ChristinaDNguyen, just to let you know that the second reviewer for this translation is now confirmed. We're delighted that Jeff Blackadar @jeffblackadar has agreed to participate, and we are expecting their review ~29th November. We'll be in touch once the second review has been submitted. Thank you!

@jeffblackadar
Copy link
Collaborator

Hi everyone,
Thank you for the opportunity to provide a review @lachapot and @digitalkosovski! I learned a lot from this lesson. It is well written and interesting - thank you to Nicolas Frerebeau and Brice Lebrun. Wonderful work with translation @ChristinaDNguyen! @semanticnoodles, your notes are most helpful. I am saving this for now, I will come back and have a second look at my comments to see if they need fixing. Please contact me if I am unclear below.

Best regards,
Jeff

Feedback

  • There is a section for Endnotes in the table of contents, but no endnotes. This could be removed.
  • para 2, with the phrase “combine several dates into one” I'm unsure of the sense of combining dates, but note the lesson deals with three different sets of dates from different labs below. Would it be to combine several results into one or several data sets into one?
  • para 3, the link to basic use of R does not work – but I think this is expected with relative links. I mention this just in case.
  • para 3, “Bayesian chronological modeling problems”. Include a link to Wikipedia like was done in para 38?
  • para 7, “The half-life of14C” – add a space between of and 14.
  • para 10, “we consider this a close[d] system”
  • para 10, “organism’s body” Would tissue be a better word than body if carbon-14 dating is also for plant material?
  • para 18, Figure 5, replace Probabilité with Probability. (Is it possible to add titles to graphs?)
  • para 30, after "credibility interval" add the abbreviation (IC) or (CI) depending on how the legend in lowest graph in figure 6 will appear.
  • para 33, at the end: "and not at a single interval (fig. 6)." Change to (fig. 6, top graph) so it's easier for the reader to locate the information?
  • para 33, Figure 6 Lowest graph, should “IC” be “CI”/Credibility Interval? Or after the text “obtained and the corresponding credibility intervals” add (IC). Graph titles will help for readability.
  • para 37, “The use of free tools” Consider changing "free" (seeming to be a cost context) to open? (but I see the word free is used later in the lesson)
  • para 38, “radiocarbon date” should this be data?
  • para 39 “Several R packages help us carry out radiocarbon date calibration. (BchronoxcAAR, etc.) are often oriented towards modeling (constructing chronologies, age-depth models, etc.). ” Edit to something like: Packages such as BchronoxcAAR, etc. are often oriented... ?
  • para 41, “different laboratories are compatible with each other” were compatible for past tense?
  • para 42, Sample 1 (Sample 1) repeats (as well as Sample 2, 3 and 4)
  • para 46 programming: I am using R in Google Colab. When I display the matrix with:
turin

I see:

646 750 676 927 940 941 1995 1980 1940 722 755 685 31 30 24 32 30 23 46 35 30 43 30 34

Yet the matrix is correctly dimensioned in memory. It just looks like a list.

If I use these commands I see the 2 dimensions of the matrix more similarly to what is in the lesson.

# age
turin[,,1]

# uncertanties
turin[,,2]

  • para 48, “can therefore get a first idea of the compatibility” get an initial idea may be a more common expression than first idea.

  • para 55, “T is a random variable which follows a χ2χ2 law” I believe distribution is better word than law as mentioned by @semanticnoodles for para 21 and 28.

  • para 62/ Figure 8. “IntCal20 calibration curve.” seems to be a sentence fragment. Should this say something like "The IntCal20 calibration curve is used." ?

  • para 70, “[ 1361;1387] “ Space before 1361 could be removed.

  • para 72, “represent these date” add s for dates.

  • para 96 / footnote 5: “consequences of atmosphere nuclear tests.” suggest atmospheric instead of atmosphere

@ChristinaDNguyen
Copy link
Collaborator

Thank you, @semanticnoodles and @jeffblackadar for both your extensive feedbacks. I appreciate the time you both spent to comb through the lesson.

@lachapot Please let me know what you would like me to do next! I am happy to begin corrections.

@lachapot
Copy link

lachapot commented Nov 4, 2024

Thank you very much for your careful and detailed feedback @jeffblackadar and @semanticnoodles!

Thank you for your message @ChristinaDNguyen! @digitalkosovski and I are going to collate and summarize the feedback from the reviews into one post and post it here, so that it's easier for you to go through and make your edits. We will post it as soon as possible, and once we do so feel free to start your edits. Hope that sounds good to you. Let us know if you have any questions in the meantime. We'll be in touch again soon!

@lachapot
Copy link

lachapot commented Nov 12, 2024

Thanks again to our reviewers @semanticnoodles and @jeffblackadar for your great feedback! And thank you @ChristinaDNguyen for all your work on the lesson so far and your patience while we collated the feedback. Here is a collated list of the feedback from our reviewers to help guide you through the suggested edits: mainly revisions concerning language and terminology, correcting typos, and some small suggested modifications to the code. Let us know if there are any points that are unclear or if there’s anything help we can do to help!

  •  para 2, clarify or reformulate the phrase “combine several dates into one”. Perhaps use a different verb than “combine” or slightly reword the phrase to make it clearer (e.g. is this “combining several dates into one dataset?)? As Jeff commented: I’m unsure of the sense of combining dates, but note the lesson deals with three different sets of dates from different labs below. Would it be to combine several results into one or several data sets into one?

  • para 3, the link to basic use of R does not work.

  •  para 3, “Bayesian chronological modeling problems”. Include a link to Wikipedia like was done in para 38?

  •  para 9, change carbon-14 at the start of the paragraph to 14C, for consistency

  •  para 10, typo: “we consider this a closed system”

  •  para 10, “organism’s body” Would "tissue" be a better word than "body" if carbon-14 dating is also for plant material?

  •  para 12, the bullet points feel a little out of place, but it’s that way in the source lesson. Perhaps a little introductory sentence or phrase could be added to introduce the two bullet points for clarification?

  •  para 15, typo: change to "observed" instead of "observerved"

  •  para 21, change to “probability distribution” instead of “probability law” (less common form)

  •  para 28, change to: “once it has been calibrated”

  •  para 28, change “normal law” to “normal distribution” and change “probability law” to “probability distribution” (distribution more common terminology)

  •  para 29, typo: Figure 5, replace “Probabilité” with “Probability”.

  • para 30, change “results” to “is derived from”

  •  para 30, after "credibility interval" add the abbreviation (IC) or (CI) depending on how the legend in lowest graph in figure 6 will appear.

  •  para 31, “HPDI” becomes “HPD interval” after this first occurrence, pick one for consistency (perhaps HPDI since that is what is used in the figures)?

  •  para 32, at the end: "and not at a single interval (fig. 6)." Change to “(fig. 6, top graph)” so it's easier for the reader to locate the information

  •  para 33, Figure 6 Lowest graph, should “IC” be “CI”/Credibility Interval? Or after the text “obtained and the corresponding credibility intervals” add (IC). Adding in graph titles would help with readability.

  •  para 37, “The use of free tools” Consider changing "free" (seeming to be a cost context) to “open”? And change other instances of “free” to “open” for consistency (e.g. in paragraph 38)

  •  para 38, “radiocarbon date” should this be “data”?

  •  para 39 “Several R packages help us carry out radiocarbon date calibration. (BchronoxcAAR, etc.) are often oriented towards modeling (constructing chronologies, age-depth models, etc.). ” Edit to something like: “Packages such as BchronoxcAAR, etc. are often oriented…" ?

  •  para 41, “different laboratories are compatible with each other” change to “were compatible” to match previous past tense?

  •  para 42, “Sample 1 (Sample 1”) repeats (as well as Sample 2, 3 and 4): perhaps delete the (Sample) in brackets?

  •  para 46 programming: cf. Jeff's feedback. I am using R in Google Colab. When I display the matrix with:

turin

I see:

646 750 676 927 940 941 1995 1980 1940 722 755 685 31 30 24 32 30 23 46 35 30 43 30 34

Yet the matrix is correctly dimensioned in memory. It just looks like a list.

If I use these commands I see the 2 dimensions of the matrix more similarly to what is in the lesson.

# age
turin[,,1]

# uncertainties
turin[,,2]
  •  para 48, “can therefore get a first idea of the compatibility” change to “get an initial idea” (may be a more common expression than “first idea”)

  •  para 49: Figure 7: only samples 3 and 4 appear in the figure (missing 1 and 2).

  •  para 55, “T is a random variable which follows a χ2 law”: change “law” to “distribution

  •  para 62/ Figure 8. “IntCal20 calibration curve.” seems to be a sentence fragment. Should this say something like "The IntCal20 calibration curve is used." ?

  •  para 67. Code block: Modifying the graphic parameters into par(mfrow = c(1, 1), mar = c(4, 1, 3, 1) + 0.1, las = 1) gets out a figure that is more easily readable (cf. Giulia's feedback)

  •  para 70, typo: “[ 1361;1387]”: delate space before 1361.

  •  para 72, “represent these date” add s for “dates”.

  •  para 93, perhaps include an English language source: e.g. Giulia suggests: Carlson, D. L. (2017). Quantitative Methods in Archaeology Using R. Cambridge: Cambridge University Press.

  •  para 96 / footnote 5: “consequences of atmosphere nuclear tests.” suggest changing to “atmospheric” instead of “atmosphere”

  •  Endnotes are appearing in the Bibliography rather than in the Endnotes section. Perhaps @charlottejmc can help with this if it’s difficult to fix?

@anisa-hawes anisa-hawes moved this from 4 Open Peer Review to 5 Revision 2 in Active Lessons Dec 5, 2024
@anisa-hawes
Copy link
Contributor

Hello Christina @ChristinaDNguyen,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 5: Revision 2.

This phase is an opportunity for you to revise your draft in response to the peer reviewers' feedback.

Laura @lachapot and Agustín @digitalkosovski have summarised their suggestions, but feel free to ask questions if you are unsure.

Please make revisions via direct commits to your file: /en/drafts/translations/calibrating-radiocarbon-dates-R.md. @charlottejmc and I are here to help if you encounter any difficulties.

When you, Laura and Agustín are all happy with the revised draft, the Managing Editor @hawc2 will read it through before we move forward to Phase 6: Sustainability + Accessibility.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#882b4f', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 4 <br> Open Peer Review
Who worked on this? : Reviewers (@semanticnoodles + @jeffblackadar)
All  Phase 4 tasks completed? : Yes
Section Phase 5 <br> Revision 2
Who's working on this? : Author (@ChristinaDNguyen)
Expected completion date? : January 5
Section Phase 6 <br> Sustainability + Accessibility
Who's responsible? : Publishing Team
Expected timeframe? : 7~21 days
Loading

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

@ChristinaDNguyen
Copy link
Collaborator

Yes, I'll be onto this in January!

Thanks for the reminder.

@anisa-hawes
Copy link
Contributor

Thank you, Christina @ChristinaDNguyen.

Let's be in touch in early 2025, and you can let us know when you think you will have capacity to revisit this.

Enjoy a restful year-end break ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 5 Revision 2
Development

No branches or pull requests

8 participants