arfc / 2019-ddca-journal-article Goto Github PK

This issue can be closed after @kipk49 reviews the first draft of this journal article.
2019-ddca.pdf

This issue can be closed when @katyhuff reviews this version of the ddca journal article.
2019-ddca.pdf

The highlights of this revision are an improved histogram plot:

And a new flow chart depicting how d3ploy selects which facilities to deploy when there is a commodity shortage:

This issue can be closed when @katyhuff reviews this version of the DDCA journal article. This version has been reviewed using the writing checklist, edited for comments made in #4 and #16.

2019-ddca.pdf

The most major change is updating the plot with a lot of crosses that compared prediction methods to a bunch of histograms. Plot here:

Figures:

• Text on figures should be generously, readably sized.
• Lines and symbols should be sized for generous readability as well ( and arranged so that the reader can, say, see the difference between two lines which are near one another.)
• All figures need and deserve excellent pixel resolution (they should not be grainy).
• All figures need and deserve all of their axes to be labeled, with units.
• All legends should be clear, with units.
• All figures should have captions, with clear sentences and citations of their source.
• Caption location at bottom of figure

Tables:

• Tables need a title (or brief caption)
• cite the source of tables that are reproduced from elsewhere
• Text should be generously, readably sized
• All values with units should make those units clear
• Numbers should line up at the decimal
• Should not be grainy.
• If two tables are adjacent, they should be of the same font size (so be careful of your screen-shotting).
• Caption location at top of table

• Run a spell checker.
• The Oxford comma appears in ("lions, tigers, and bears.")
• Do not use the word "where" unless referring to a location (try "such that" or "in which").
• Articles such as "a" "the" "some" "any" and "each" appear where necessary.
• All subjects match the plurality of their verbs ( no: "Apples is tasty" yes: "Apples are tasty")
• Avoid run-on sentences.
• clunky nouns -> spunky verbs (progression, expression --> progress, express)
• reduce vague words (important, methodologic)
• reduce acronyms / jargon
• get rid of unnecessary prepositional phrases -- author clearing throat (It can be shown that)
• get rid of extraneous adverbs (very, really, quite, basically, generally)
• get rid of there are / there is
• turn negatives to positives (she was not often right -> she was usually wrong)
• get rid of extraneous prepositions (the meeting happened on monday -> the meeting happened monday) (they agreed that it was true -> they agreed it was true)
• get rid of passive voice (is/was/are/were/be/been/am + past tense verb), replace with active voice
• use strong verbs (use sparingly: is, are, was, were, be, been, am)
• avoid turning verbs into nouns ("obtain estimates of" -> "estimates"; "provides a description of" -> "describes", was conducted on/of)
• don't bury the verb (keep the predicate close to the subject at the beginning of the sentence)
• data is plural (the data are critical)
• compare to (point out similarities between different things) vs. compared with (point out differences between similar things)
• punctuation helps you to vary your sentence structure
• Power to separate in increasing power: comma, colon, dash, parentheses, semicolon, period
• In increasing order of formality: dash, parentheses, all of the others. Don't overdo it with the dash and parentheses
• semicolon: connects two independent clauses. OR used to separate when the items in the list contain internal punctuation.
• use a colon to introduce a list, quote, explanation, conclusion, or amplification
• if there's a list in a sentence, it shouldn't come before the colon
• use a dash to insert something in the middle of the sentence. Don't overuse it.

• Run a spell checker.
• The Oxford comma appears in ("lions, tigers, and bears.")
• Do not use the word "where" unless referring to a location (try "such that" or "in which").
• Articles such as "a" "the" "some" "any" and "each" appear where necessary.
• All subjects match the plurality of their verbs ( no: "Apples is tasty" yes: "Apples are tasty")
• Avoid run-on sentences.
• clunky nouns -> spunky verbs (progression, expression --> progress, express)
• reduce vague words (important, methodologic)
• reduce acronyms / jargon
• get rid of unnecessary prepositional phrases -- author clearing throat (It can be shown that)
• get rid of extraneous adverbs (very, really, quite, basically, generally)
• get rid of there are / there is
• turn negatives to positives (she was not often right -> she was usually wrong)
• get rid of extraneous prepositions (the meeting happened on monday -> the meeting happened monday) (they agreed that it was true -> they agreed it was true)
• get rid of passive voice (is/was/are/were/be/been/am + past tense verb), replace with active voice
• use strong verbs (use sparingly: is, are, was, were, be, been, am)
• avoid turning verbs into nouns ("obtain estimates of" -> "estimates"; "provides a description of" -> "describes", was conducted on/of, with a)
• don't bury the verb (keep the predicate close to the subject at the beginning of the sentence)
• data is plural (the data are critical)
• compare to (point out similarities between different things) vs. compared with (point out differences between similar things)
• punctuation helps you to vary your sentence structure
• Power to separate in increasing power: comma, colon, dash, parentheses, semicolon, period
• In increasing order of formality: dash, parentheses, all of the others. Don't overdo it with the dash and parentheses
• semicolon: connects two independent clauses. OR used to separate when the items in the list contain internal punctuation.
• use a colon to introduce a list, quote, explanation, conclusion, or amplification
• if there's a list in a sentence, it shouldn't come before the colon
• use a dash to insert something in the middle of the sentence. Don't overuse it.

This issue can be closed when @katyhuff reviews this current draft of the journal article.
2019-ddca.pdf

This issue can be closed after @robfairh reviews the first draft of this journal article.
2019-ddca.pdf

I'll start reading the new version. In the meantime, see some high level comments for the later pages on the pdf version I had started to review in #4 .
2019-ddca.pdf

There is a lot of unnecessary passive voice in this document. This indicates to me that the writing checklist may not have been reviewed. This issue can be closed when each item in the writing checklist has been addressed. Please pay special attention to those issues which are bolded below.

• Run a spell checker.
• The Oxford comma appears in ("lions, tigers, and bears.")
• Do not use the word "where" unless referring to a location (try "such that" or "in which").
• Articles such as "a" "the" "some" "any" and "each" appear where necessary.
• All subjects match the plurality of their verbs ( no: "Apples is tasty" yes: "Apples are tasty")
• Avoid run-on sentences.
• clunky nouns -> spunky verbs (progression, expression --> progress, express)
• reduce vague words (important, methodologic)
• reduce acronyms / jargon
• get rid of unnecessary prepositional phrases -- author clearing throat (It can be shown that)
• get rid of extraneous adverbs (very, really, quite, basically, generally)
• get rid of there are / there is
• turn negatives to positives (she was not often right -> she was usually wrong)
• get rid of extraneous prepositions (the meeting happened on monday -> the meeting happened monday) (they agreed that it was true -> they agreed it was true)
• get rid of passive voice (is/was/are/were/be/been/am + past tense verb), replace with active voice
• use strong verbs (use sparingly: is, are, was, were, be, been, am)
• avoid turning verbs into nouns ("obtain estimates of" -> "estimates"; "provides a description of" -> "describes")
• don't bury the verb (keep the predicate close to the subject at the beginning of the sentence)
• data is plural (the data are critical)
• compare to (point out similarities between different things) vs. compared with (point out differences between similar things)
• punctuation helps you to vary your sentence structure
• Power to separate in increasing power: comma, colon, dash, parentheses, semicolon, period
• In increasing order of formality: dash, parentheses, all of the others. Don't overdo it with the dash and parentheses
• semicolon: connects two independent clauses. OR used to separate when the items in the list contain internal punctuation.
• use a colon to introduce a list, quote, explanation, conclusion, or amplification
• if there's a list in a sentence, it shouldn't come before the colon
• use a dash to insert something in the middle of the sentence. Don't overuse it.

This issue can be closed after @katyhuff reviews the Nuclear Technology cover letter.
cover-letter.pdf

There is a lot of unnecessary passive voice in this document. This indicates to me that the writing checklist may not have been reviewed. This issue can be closed when each item in the writing checklist has been addressed. Please pay special attention to those issues which are bolded below.

• Run a spell checker.
• The Oxford comma appears in ("lions, tigers, and bears.")
• Do not use the word "where" unless referring to a location (try "such that" or "in which").
• Articles such as "a" "the" "some" "any" and "each" appear where necessary.
• All subjects match the plurality of their verbs ( no: "Apples is tasty" yes: "Apples are tasty")
• Avoid run-on sentences.
• clunky nouns -> spunky verbs (progression, expression --> progress, express)
• reduce vague words (important, methodologic)
• reduce acronyms / jargon
• get rid of unnecessary prepositional phrases -- author clearing throat (It can be shown that)
• get rid of extraneous adverbs (very, really, quite, basically, generally)
• get rid of there are / there is
• turn negatives to positives (she was not often right -> she was usually wrong)
• get rid of extraneous prepositions (the meeting happened on monday -> the meeting happened monday) (they agreed that it was true -> they agreed it was true)
• get rid of passive voice (is/was/are/were/be/been/am + past tense verb), replace with active voice EG: this is a...
• use strong verbs (use sparingly: is, are, was, were, be, been, am)
• avoid turning verbs into nouns ("obtain estimates of" -> "estimates"; "provides a description of" -> "describes", was conducted on/of)
• don't bury the verb (keep the predicate close to the subject at the beginning of the sentence)
• data is plural (the data are critical)
• compare to (point out similarities between different things) vs. compared with (point out differences between similar things)
• punctuation helps you to vary your sentence structure
• Power to separate in increasing power: comma, colon, dash, parentheses, semicolon, period
• In increasing order of formality: dash, parentheses, all of the others. Don't overdo it with the dash and parentheses
• semicolon: connects two independent clauses. OR used to separate when the items in the list contain internal punctuation.
• use a colon to introduce a list, quote, explanation, conclusion, or amplification
• if there's a list in a sentence, it shouldn't come before the colon
• use a dash to insert something in the middle of the sentence. Don't overuse it.

This issue can be closed when @katyhuff reviews this version of the DDCA journal article. This version has been reviewed using the writing checklist, edited for comments made in #4, and is hopefully grammar mistake-free.
2019-ddca.pdf

• Run a spell checker.
• The Oxford comma appears in ("lions, tigers, and bears.")
• Do not use the word "where" unless referring to a location (try "such that" or "in which").
• Articles such as "a" "the" "some" "any" and "each" appear where necessary.
• All subjects match the plurality of their verbs ( no: "Apples is tasty" yes: "Apples are tasty")
• Avoid run-on sentences.
• clunky nouns -> spunky verbs (progression, expression --> progress, express)
• reduce vague words (important, methodologic)
• reduce acronyms / jargon
• get rid of unnecessary prepositional phrases -- author clearing throat (It can be shown that)
• get rid of extraneous adverbs (very, really, quite, basically, generally)
• get rid of there are / there is
• turn negatives to positives (she was not often right -> she was usually wrong)
• get rid of extraneous prepositions (the meeting happened on monday -> the meeting happened monday) (they agreed that it was true -> they agreed it was true)
• get rid of passive voice (is/was/are/were/be/been/am + past tense verb), replace with active voice
• use strong verbs (use sparingly: is, are, was, were, be, been, am)
• avoid turning verbs into nouns ("obtain estimates of" -> "estimates"; "provides a description of" -> "describes"; was conducted of/to)
• don't bury the verb (keep the predicate close to the subject at the beginning of the sentence)
• data is plural (the data are critical)
• compare to (point out similarities between different things) vs. compared with (point out differences between similar things)
• punctuation helps you to vary your sentence structure
• Power to separate in increasing power: comma, colon, dash, parentheses, semicolon, period
• In increasing order of formality: dash, parentheses, all of the others. Don't overdo it with the dash and parentheses
• semicolon: connects two independent clauses. OR used to separate when the items in the list contain internal punctuation.
• use a colon to introduce a list, quote, explanation, conclusion, or amplification
• if there's a list in a sentence, it shouldn't come before the colon
• use a dash to insert something in the middle of the sentence. Don't overuse it.