Re: [R] what constitutes a 'complete sentence'?
On 07 Jul 2015, at 16:52 , Max Kuhn mxk...@gmail.com wrote: What are we trying to fix? Two things, actually. (1) An error message that sends the package developer on a wild goose chase, because it is both out of sync both with what is wanted, and what is checked for. (2) The description in the WRE manual is somewhat self-contradicting, and could probably be improved. To my mind, the tricky one is (1). (2) should be easier because there is space to elaborate. (1) needs to be succinct, which is hard if there is no single term for what is being required. I'm beginning to think that the best we can do is along the lines of Malformed Description field: Missing end punctuation.. If more checks are devised, add more messages. -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Office: A 4.23 Email: pd@cbs.dk Priv: pda...@gmail.com __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
Dear Max, I think that the object is to describe clearly what CRAN wants in the description field so that package authors don't write description fields that are unacceptable to CRAN. Clear criteria would save both package authors' and CRAN maintainers' time. Although a mechanical check can find some problems with descriptions, I doubt whether it's possible to write a mechanical check that will fully implement what CRAN wants. John -Original Message- From: R-help [mailto:r-help-boun...@r-project.org] On Behalf Of Max Kuhn Sent: July-07-15 10:53 AM To: John Fox Cc: R Help; Federico Calboli; peter dalgaard Subject: Re: [R] what constitutes a 'complete sentence'? On Tue, Jul 7, 2015 at 8:19 AM, John Fox j...@mcmaster.ca wrote: Dear Peter, You're correct that these examples aren't verb phrases (though the second one contains a verb phrase). I don't want to make the discussion even more pedantic (moving it in this direction was my fault), but Paragraph isn't quite right, unless explained, because conventionally a paragraph consists of sentences. How about something like this? One can use several complete sentences or punctuated telegraphic phrases, but only one paragraph (that is, block of continuous text with no intervening blank lines). The description should end with a full stop (period). Before we start crafting better definitions of the rule, it seems important to understand what issue we are trying to solve. I don't see any place where this has been communicated. As I said previously, I usually give them the benefit of the doubt. However, this requirement is poorly implemented and we need to know more. For example, does CRAN need to parse the text and the code failed because there was no period? It seems plausible that someone could have worded that requirement in the current form, but it is poorly written (which is unusual). If the goal is to improve the quality of the description text, then that is a more difficult issue to define. and good luck coding your way into a lucid and effective set of rules. It also seems a bit over the top to me and a poor choice of where everyone should be spending their time. What are we trying to fix? It would likely be helpful to add some examples of good and bad descriptions, and to explain how the check actually works. Best, John On Tue, 7 Jul 2015 12:20:38 +0200 peter dalgaard pda...@gmail.com wrote: ...except that there is not necessarily a verb either. What we're looking for is something like advertisement style as in UGLY MUGS 7.95. An invaluable addition to your display cabinet. Comes in an assortment of warts and wrinkles, crafted by professional artist Foo Yung. However, I'm drawing blanks when searching for an established term for it. Could we perhaps sidestep the issue by requesting a single descriptive paragraph, with punctuation or thereabouts? I'm still puzzled about what threw Federico's example in the first place. The actual code is if(strict !is.na(val - db[Description]) !grepl([.!?]['\)]?$, trimws(val))) out$bad_Description - TRUE and I can do this strict - TRUE db - tools:::.read_description(/tmp/dd) if(strict !is.na(val - db[Description]) + !grepl([.!?]['\)]?$, trimws(val))) + out$bad_Description - TRUE out Error: object 'out' not found I.e., the complaint should _not_ be triggered. I suppose that something like a non-breakable space at the end could confuse trimws(), but beyond that I'm out of ideas. On 07 Jul 2015, at 03:28 , John Fox j...@mcmaster.ca wrote: Dear Peter, I think that the grammatical term you're looking for is verb phrase. Best, John On Tue, 7 Jul 2015 00:12:25 +0200 peter dalgaard pda...@gmail.com wrote: On 06 Jul 2015, at 23:19 , Duncan Murdoch murdoch.dun...@gmail.com wrote: On 06/07/2015 5:09 PM, Rolf Turner wrote: On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do
Re: [R] what constitutes a 'complete sentence'?
Dear Peter, You're correct that these examples aren't verb phrases (though the second one contains a verb phrase). I don't want to make the discussion even more pedantic (moving it in this direction was my fault), but Paragraph isn't quite right, unless explained, because conventionally a paragraph consists of sentences. How about something like this? One can use several complete sentences or punctuated telegraphic phrases, but only one paragraph (that is, block of continuous text with no intervening blank lines). The description should end with a full stop (period). It would likely be helpful to add some examples of good and bad descriptions, and to explain how the check actually works. Best, John On Tue, 7 Jul 2015 12:20:38 +0200 peter dalgaard pda...@gmail.com wrote: ...except that there is not necessarily a verb either. What we're looking for is something like advertisement style as in UGLY MUGS 7.95. An invaluable addition to your display cabinet. Comes in an assortment of warts and wrinkles, crafted by professional artist Foo Yung. However, I'm drawing blanks when searching for an established term for it. Could we perhaps sidestep the issue by requesting a single descriptive paragraph, with punctuation or thereabouts? I'm still puzzled about what threw Federico's example in the first place. The actual code is if(strict !is.na(val - db[Description]) !grepl([.!?]['\)]?$, trimws(val))) out$bad_Description - TRUE and I can do this strict - TRUE db - tools:::.read_description(/tmp/dd) if(strict !is.na(val - db[Description]) + !grepl([.!?]['\)]?$, trimws(val))) + out$bad_Description - TRUE out Error: object 'out' not found I.e., the complaint should _not_ be triggered. I suppose that something like a non-breakable space at the end could confuse trimws(), but beyond that I'm out of ideas. On 07 Jul 2015, at 03:28 , John Fox j...@mcmaster.ca wrote: Dear Peter, I think that the grammatical term you're looking for is verb phrase. Best, John On Tue, 7 Jul 2015 00:12:25 +0200 peter dalgaard pda...@gmail.com wrote: On 06 Jul 2015, at 23:19 , Duncan Murdoch murdoch.dun...@gmail.com wrote: On 06/07/2015 5:09 PM, Rolf Turner wrote: On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do with complete sentences? The package checker issues a message saying that it wants a complete sentence when this has nothing to do with what it *really* wants. That's false. If you haven't given a complete sentence, you might still pass, but if you have, you will pass. That's not nothing to do with what it really wants, it's just an imperfect test that fails to detect violations of the guidelines. As we've seen, it sometimes also makes mistakes in the other direction. I'd say those are more serious. Duncan Murdoch Ackchewly I don't think what we want is what we say that we want. A quick check suggests that many/most packages use headline speech, as in Provides functions for analysis of foo, with special emphasis on bar., which seems perfectly ok. As others have indicated, prefixing with This package would be rather useless. However, I'm at a loss as to how to describe what it is that we want, much less how to translate it to a dozen other languages. -pd -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Email: pd@cbs.dk Priv: pda...@gmail.com __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Office: A 4.23 Email: pd@cbs.dk Priv: pda...@gmail.com
Re: [R] what constitutes a 'complete sentence'?
...except that there is not necessarily a verb either. What we're looking for is something like advertisement style as in UGLY MUGS 7.95. An invaluable addition to your display cabinet. Comes in an assortment of warts and wrinkles, crafted by professional artist Foo Yung. However, I'm drawing blanks when searching for an established term for it. Could we perhaps sidestep the issue by requesting a single descriptive paragraph, with punctuation or thereabouts? I'm still puzzled about what threw Federico's example in the first place. The actual code is if(strict !is.na(val - db[Description]) !grepl([.!?]['\)]?$, trimws(val))) out$bad_Description - TRUE and I can do this strict - TRUE db - tools:::.read_description(/tmp/dd) if(strict !is.na(val - db[Description]) + !grepl([.!?]['\)]?$, trimws(val))) + out$bad_Description - TRUE out Error: object 'out' not found I.e., the complaint should _not_ be triggered. I suppose that something like a non-breakable space at the end could confuse trimws(), but beyond that I'm out of ideas. On 07 Jul 2015, at 03:28 , John Fox j...@mcmaster.ca wrote: Dear Peter, I think that the grammatical term you're looking for is verb phrase. Best, John On Tue, 7 Jul 2015 00:12:25 +0200 peter dalgaard pda...@gmail.com wrote: On 06 Jul 2015, at 23:19 , Duncan Murdoch murdoch.dun...@gmail.com wrote: On 06/07/2015 5:09 PM, Rolf Turner wrote: On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do with complete sentences? The package checker issues a message saying that it wants a complete sentence when this has nothing to do with what it *really* wants. That's false. If you haven't given a complete sentence, you might still pass, but if you have, you will pass. That's not nothing to do with what it really wants, it's just an imperfect test that fails to detect violations of the guidelines. As we've seen, it sometimes also makes mistakes in the other direction. I'd say those are more serious. Duncan Murdoch Ackchewly I don't think what we want is what we say that we want. A quick check suggests that many/most packages use headline speech, as in Provides functions for analysis of foo, with special emphasis on bar., which seems perfectly ok. As others have indicated, prefixing with This package would be rather useless. However, I'm at a loss as to how to describe what it is that we want, much less how to translate it to a dozen other languages. -pd -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Email: pd@cbs.dk Priv: pda...@gmail.com __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Office: A 4.23 Email: pd@cbs.dk Priv: pda...@gmail.com __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
In line below On 07/07/2015 11:20, peter dalgaard wrote: ...except that there is not necessarily a verb either. What we're looking for is something like advertisement style as in UGLY MUGS 7.95. An invaluable addition to your display cabinet. Comes in an assortment of warts and wrinkles, crafted by professional artist Foo Yung. However, I'm drawing blanks when searching for an established term for it. People who try to measure readability seem to define sentence as 'a sequence of words terminated by a stop'. They presumably count question marks and exclamation marks as a stop. So Peter's examples above are indeed sentences for one meaning of sentence. Could we perhaps sidestep the issue by requesting a single descriptive paragraph, with punctuation or thereabouts? I'm still puzzled about what threw Federico's example in the first place. The actual code is if(strict !is.na(val - db[Description]) !grepl([.!?]['\)]?$, trimws(val))) out$bad_Description - TRUE and I can do this strict - TRUE db - tools:::.read_description(/tmp/dd) if(strict !is.na(val - db[Description]) + !grepl([.!?]['\)]?$, trimws(val))) + out$bad_Description - TRUE out Error: object 'out' not found I.e., the complaint should _not_ be triggered. I suppose that something like a non-breakable space at the end could confuse trimws(), but beyond that I'm out of ideas. On 07 Jul 2015, at 03:28 , John Fox j...@mcmaster.ca wrote: Dear Peter, I think that the grammatical term you're looking for is verb phrase. Best, John On Tue, 7 Jul 2015 00:12:25 +0200 peter dalgaard pda...@gmail.com wrote: On 06 Jul 2015, at 23:19 , Duncan Murdoch murdoch.dun...@gmail.com wrote: On 06/07/2015 5:09 PM, Rolf Turner wrote: On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do with complete sentences? The package checker issues a message saying that it wants a complete sentence when this has nothing to do with what it *really* wants. That's false. If you haven't given a complete sentence, you might still pass, but if you have, you will pass. That's not nothing to do with what it really wants, it's just an imperfect test that fails to detect violations of the guidelines. As we've seen, it sometimes also makes mistakes in the other direction. I'd say those are more serious. Duncan Murdoch Ackchewly I don't think what we want is what we say that we want. A quick check suggests that many/most packages use headline speech, as in Provides functions for analysis of foo, with special emphasis on bar., which seems perfectly ok. As others have indicated, prefixing with This package would be rather useless. However, I'm at a loss as to how to describe what it is that we want, much less how to translate it to a dozen other languages. -pd -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Email: pd@cbs.dk Priv: pda...@gmail.com __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- Michael http://www.dewey.myzen.co.uk/home.html __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
On Tue, Jul 7, 2015 at 8:19 AM, John Fox j...@mcmaster.ca wrote: Dear Peter, You're correct that these examples aren't verb phrases (though the second one contains a verb phrase). I don't want to make the discussion even more pedantic (moving it in this direction was my fault), but Paragraph isn't quite right, unless explained, because conventionally a paragraph consists of sentences. How about something like this? One can use several complete sentences or punctuated telegraphic phrases, but only one paragraph (that is, block of continuous text with no intervening blank lines). The description should end with a full stop (period). Before we start crafting better definitions of the rule, it seems important to understand what issue we are trying to solve. I don't see any place where this has been communicated. As I said previously, I usually give them the benefit of the doubt. However, this requirement is poorly implemented and we need to know more. For example, does CRAN need to parse the text and the code failed because there was no period? It seems plausible that someone could have worded that requirement in the current form, but it is poorly written (which is unusual). If the goal is to improve the quality of the description text, then that is a more difficult issue to define. and good luck coding your way into a lucid and effective set of rules. It also seems a bit over the top to me and a poor choice of where everyone should be spending their time. What are we trying to fix? It would likely be helpful to add some examples of good and bad descriptions, and to explain how the check actually works. Best, John On Tue, 7 Jul 2015 12:20:38 +0200 peter dalgaard pda...@gmail.com wrote: ...except that there is not necessarily a verb either. What we're looking for is something like advertisement style as in UGLY MUGS 7.95. An invaluable addition to your display cabinet. Comes in an assortment of warts and wrinkles, crafted by professional artist Foo Yung. However, I'm drawing blanks when searching for an established term for it. Could we perhaps sidestep the issue by requesting a single descriptive paragraph, with punctuation or thereabouts? I'm still puzzled about what threw Federico's example in the first place. The actual code is if(strict !is.na(val - db[Description]) !grepl([.!?]['\)]?$, trimws(val))) out$bad_Description - TRUE and I can do this strict - TRUE db - tools:::.read_description(/tmp/dd) if(strict !is.na(val - db[Description]) + !grepl([.!?]['\)]?$, trimws(val))) + out$bad_Description - TRUE out Error: object 'out' not found I.e., the complaint should _not_ be triggered. I suppose that something like a non-breakable space at the end could confuse trimws(), but beyond that I'm out of ideas. On 07 Jul 2015, at 03:28 , John Fox j...@mcmaster.ca wrote: Dear Peter, I think that the grammatical term you're looking for is verb phrase. Best, John On Tue, 7 Jul 2015 00:12:25 +0200 peter dalgaard pda...@gmail.com wrote: On 06 Jul 2015, at 23:19 , Duncan Murdoch murdoch.dun...@gmail.com wrote: On 06/07/2015 5:09 PM, Rolf Turner wrote: On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do with complete sentences? The package checker issues a message saying that it wants a complete sentence when this has nothing to do with what it *really* wants. That's false. If you haven't given a complete sentence, you might still pass, but if you have, you will pass. That's not nothing to do with what it really wants, it's just an imperfect test that fails to detect violations of the guidelines. As we've seen, it sometimes also makes mistakes in the other direction. I'd say those are more serious. Duncan Murdoch Ackchewly I don't think what we want is what we say that we want. A quick check suggests that many/most packages use headline speech, as in Provides functions for analysis of foo, with special emphasis on bar., which seems perfectly ok. As others have
Re: [R] what constitutes a 'complete sentence'?
On 7 Jul 2015, at 01:12, peter dalgaard pda...@gmail.com wrote: On 06 Jul 2015, at 23:19 , Duncan Murdoch murdoch.dun...@gmail.com wrote: On 06/07/2015 5:09 PM, Rolf Turner wrote: On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do with complete sentences? The package checker issues a message saying that it wants a complete sentence when this has nothing to do with what it *really* wants. That's false. If you haven't given a complete sentence, you might still pass, but if you have, you will pass. That's not nothing to do with what it really wants, it's just an imperfect test that fails to detect violations of the guidelines. As we've seen, it sometimes also makes mistakes in the other direction. I'd say those are more serious. Duncan Murdoch Ackchewly I don't think what we want is what we say that we want. A quick check suggests that many/most packages use headline speech, as in Provides functions for analysis of foo, with special emphasis on bar., which seems perfectly ok. As others have indicated, prefixing with This package would be rather useless. However, I'm at a loss as to how to describe what it is that we want, much less how to translate it to a dozen other languages. You are hitting the nail on the head — R asks for a *description* without defining any grammatical rule for it aside from the nebulous ‘complete sentence’ (nebulous because of how it is enforced) and ’this package': The mandatory ‘Description’ field should give a comprehensive description of what the package does. One can use several (complete) sentences, but only one paragraph. It should be intelligible to all the intended readership (e.g. for a CRAN package to all CRAN users). It is good practice not to start with the package name, ‘This package’ or similar. I am puzzled by the idea that people that deal with stats, maths and computers should define what is a grammatically acceptable description, as opposed to a description. If I describe my package poorly it might not be used as much, and thus it might represent a wasted effort for *me*. Incidentally, not being able to use ‘pkgname' or ‘this package’ decreases the chances of successfully deploying a subject-verb-object sentence. BW F -pd -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Email: pd@cbs.dk Priv: pda...@gmail.com -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do with complete sentences? The package checker issues a message saying that it wants a complete sentence when this has nothing to do with what it *really* wants. cheers, Rolf -- Technical Editor ANZJS Department of Statistics University of Auckland Phone: +64-9-373-7599 ext. 88276 __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
On 06/07/2015 5:09 PM, Rolf Turner wrote: On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do with complete sentences? The package checker issues a message saying that it wants a complete sentence when this has nothing to do with what it *really* wants. That's false. If you haven't given a complete sentence, you might still pass, but if you have, you will pass. That's not nothing to do with what it really wants, it's just an imperfect test that fails to detect violations of the guidelines. As we've seen, it sometimes also makes mistakes in the other direction. I'd say those are more serious. Duncan Murdoch __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. Bill Dunlap TIBCO Software wdunlap tibco.com On Fri, Jul 3, 2015 at 3:26 PM, Rolf Turner r.tur...@auckland.ac.nz wrote: On 04/07/15 06:27, Yihui Xie wrote: Sigh, how natural it is to say This package ..., but you probably don't know a package can be easily rejected by CRAN simply because of this phrase This package (it has been clearly stated in the R-exts manual). Urrr! I *did* know that, but had forgotten. Apologies for my wrong-headed suggestion. Thanks for pointing out my error. I don't think the grammar is the problem here. When in doubt, I always check what MASS does: http://cran.rstudio.com/web/packages/MASS/index.html Turns out its description is not a complete sentence, either. Sounds like R has become a language for statistical computing and graphics, plus English grammar since 3.0.x. The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. cheers, Rolf Turner -- Technical Editor ANZJS Department of Statistics University of Auckland Phone: +64-9-373-7599 ext. 88276 __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. [[alternative HTML version deleted]] __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
On 06 Jul 2015, at 23:19 , Duncan Murdoch murdoch.dun...@gmail.com wrote: On 06/07/2015 5:09 PM, Rolf Turner wrote: On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do with complete sentences? The package checker issues a message saying that it wants a complete sentence when this has nothing to do with what it *really* wants. That's false. If you haven't given a complete sentence, you might still pass, but if you have, you will pass. That's not nothing to do with what it really wants, it's just an imperfect test that fails to detect violations of the guidelines. As we've seen, it sometimes also makes mistakes in the other direction. I'd say those are more serious. Duncan Murdoch Ackchewly I don't think what we want is what we say that we want. A quick check suggests that many/most packages use headline speech, as in Provides functions for analysis of foo, with special emphasis on bar., which seems perfectly ok. As others have indicated, prefixing with This package would be rather useless. However, I'm at a loss as to how to describe what it is that we want, much less how to translate it to a dozen other languages. -pd -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Email: pd@cbs.dk Priv: pda...@gmail.com __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
Dear Peter, I think that the grammatical term you're looking for is verb phrase. Best, John On Tue, 7 Jul 2015 00:12:25 +0200 peter dalgaard pda...@gmail.com wrote: On 06 Jul 2015, at 23:19 , Duncan Murdoch murdoch.dun...@gmail.com wrote: On 06/07/2015 5:09 PM, Rolf Turner wrote: On 07/07/15 07:10, William Dunlap wrote: [Rolf Turner wrote.] The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. This may be true, but also think of the user when you write the description. If you are scanning a long list of descriptions looking for a package to use, seeing a description that starts with 'A package for' just slows you down. Seeing a description that includes 'designed to' leaves you wondering if the implementation is woefully incomplete. You want to go beyond what CRAN can test for. All very true and sound and wise, but what has this got to do with complete sentences? The package checker issues a message saying that it wants a complete sentence when this has nothing to do with what it *really* wants. That's false. If you haven't given a complete sentence, you might still pass, but if you have, you will pass. That's not nothing to do with what it really wants, it's just an imperfect test that fails to detect violations of the guidelines. As we've seen, it sometimes also makes mistakes in the other direction. I'd say those are more serious. Duncan Murdoch Ackchewly I don't think what we want is what we say that we want. A quick check suggests that many/most packages use headline speech, as in Provides functions for analysis of foo, with special emphasis on bar., which seems perfectly ok. As others have indicated, prefixing with This package would be rather useless. However, I'm at a loss as to how to describe what it is that we want, much less how to translate it to a dozen other languages. -pd -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Email: pd@cbs.dk Priv: pda...@gmail.com __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
A couple of pointers: (a) R-package-devel exists and is right -- thataway (b) R is open source, and QC.R is pretty easy to find. Reading the source, it appears that the check is only for whether the Description: field is terminated by punctuation, possibly followed by a quote. (c) I'd try read.dcf(DESCRIPTION)[,Description] and check that it contains what you think it would contain. -pd On 05 Jul 2015, at 11:13 , jwd j...@surewest.net wrote: On Fri, 3 Jul 2015 11:09:54 +0300 Federico Calboli federico.calb...@helsinki.fi wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F Well, no. It isn't a complete sentence which requires a subject, and object and a verb. However, there are not many package Descriptions that ARE complete sentences. Some could be reworded awkwardly into a functional sentence. You could for instance try: [Library/Package name] is a collection of functions designed to test for pleiotropy on genetic and genomic data. That is a complete sentence as it contains a form of the verb to be, to whit is. By using the package name you also avoid the stricture against The package consists ... JWdougherty __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- Peter Dalgaard, Professor, Center for Statistics, Copenhagen Business School Solbjerg Plads 3, 2000 Frederiksberg, Denmark Phone: (+45)38153501 Email: pd@cbs.dk Priv: pda...@gmail.com __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
On Fri, 3 Jul 2015 11:09:54 +0300 Federico Calboli federico.calb...@helsinki.fi wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F Well, no. It isn't a complete sentence which requires a subject, and object and a verb. However, there are not many package Descriptions that ARE complete sentences. Some could be reworded awkwardly into a functional sentence. You could for instance try: [Library/Package name] is a collection of functions designed to test for pleiotropy on genetic and genomic data. That is a complete sentence as it contains a form of the verb to be, to whit is. By using the package name you also avoid the stricture against The package consists ... JWdougherty __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
On 05/07/15 01:09, mxkuhn wrote: SNIP Whenever I find a new rule or test with R CMD check, I tell myself that it must be there because of some previous issue, i.e. they probably had a good reason. I can't imagine what damage an incomplete sentence caused beyond a bruised aura. Fortune nomination. cheers, Rolf Turner -- Technical Editor ANZJS Department of Statistics University of Auckland Phone: +64-9-373-7599 ext. 88276 __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
I encountered this a few months ago and, in my case, the sentence had a noun and verb but lacked a period at the end of the sentence. I tested that 'blah blah blah.' would have passed in that version of R-devel. Whenever I find a new rule or test with R CMD check, I tell myself that it must be there because of some previous issue, i.e. they probably had a good reason. I can't imagine what damage an incomplete sentence caused beyond a bruised aura. On Jul 4, 2015, at 1:41 AM, Duncan Murdoch murdoch.dun...@gmail.com wrote: On 04/07/2015 12:26 AM, Rolf Turner wrote: On 04/07/15 06:27, Yihui Xie wrote: Sigh, how natural it is to say This package ..., but you probably don't know a package can be easily rejected by CRAN simply because of this phrase This package (it has been clearly stated in the R-exts manual). Urrr! I *did* know that, but had forgotten. Apologies for my wrong-headed suggestion. Thanks for pointing out my error. I don't think the grammar is the problem here. When in doubt, I always check what MASS does: http://cran.rstudio.com/web/packages/MASS/index.html Turns out its description is not a complete sentence, either. Sounds like R has become a language for statistical computing and graphics, plus English grammar since 3.0.x. The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. There's often a difference between a requirement and the test for it. If you meet the requirement, you should pass the test, but you can often pass the test without meeting the requirement, and then you may find that the test is improved in a later version. (Requirements may also be changed, of course.) Duncan Murdoch __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
That exists already: last slide here — it looks like it is a know issue. BW F On 3 Jul 2015, at 14:13, Hadley Wickham h.wick...@gmail.com wrote: In that case, you need to create a minimal reproducible example and make it publicly available. Hadley On Friday, July 3, 2015, Federico Calboli federico.calb...@helsinki.fi wrote: On 3 Jul 2015, at 12:14, Hadley Wickham h.wick...@gmail.com wrote: It might be a line break problem - I think you want: Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. Tried this and unfortunately it does not help. BW F Hadley On Fri, Jul 3, 2015 at 10:09 AM, Federico Calboli federico.calb...@helsinki.fi wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- http://had.co.nz/ -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi -- http://had.co.nz/ -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
On 3 Jul 2015, at 12:14, Hadley Wickham h.wick...@gmail.com wrote: It might be a line break problem - I think you want: Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. Tried this and unfortunately it does not help. BW F Hadley On Fri, Jul 3, 2015 at 10:09 AM, Federico Calboli federico.calb...@helsinki.fi wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- http://had.co.nz/ -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
Hi without going deep into this matter, what if you remove / from your sentence. Cheers Petr -Original Message- From: R-help [mailto:r-help-boun...@r-project.org] On Behalf Of Hadley Wickham Sent: Friday, July 03, 2015 1:14 PM To: Federico Calboli Cc: R-help Subject: Re: [R] what constitutes a 'complete sentence'? In that case, you need to create a minimal reproducible example and make it publicly available. Hadley On Friday, July 3, 2015, Federico Calboli federico.calb...@helsinki.fi wrote: On 3 Jul 2015, at 12:14, Hadley Wickham h.wick...@gmail.com javascript:; wrote: It might be a line break problem - I think you want: Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. Tried this and unfortunately it does not help. BW F Hadley On Fri, Jul 3, 2015 at 10:09 AM, Federico Calboli federico.calb...@helsinki.fi javascript:; wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi javascript:; __ R-help@r-project.org javascript:; mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- http://had.co.nz/ -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi javascript:; -- http://had.co.nz/ [[alternative HTML version deleted]] __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting- guide.html and provide commented, minimal, self-contained, reproducible code. Tento e-mail a jakékoliv k němu připojené dokumenty jsou důvěrné a jsou určeny pouze jeho adresátům. Jestliže jste obdržel(a) tento e-mail omylem, informujte laskavě neprodleně jeho odesílatele. Obsah tohoto emailu i s přílohami a jeho kopie vymažte ze svého systému. Nejste-li zamýšleným adresátem tohoto emailu, nejste oprávněni tento email jakkoliv užívat, rozšiřovat, kopírovat či zveřejňovat. Odesílatel e-mailu neodpovídá za eventuální škodu způsobenou modifikacemi či zpožděním přenosu e-mailu. V případě, že je tento e-mail součástí obchodního jednání: - vyhrazuje si odesílatel právo ukončit kdykoliv jednání o uzavření smlouvy, a to z jakéhokoliv důvodu i bez uvedení důvodu. - a obsahuje-li nabídku, je adresát oprávněn nabídku bezodkladně přijmout; Odesílatel tohoto e-mailu (nabídky) vylučuje přijetí nabídky ze strany příjemce s dodatkem či odchylkou. - trvá odesílatel na tom, že příslušná smlouva je uzavřena teprve výslovným dosažením shody na všech jejích náležitostech. - odesílatel tohoto emailu informuje, že není oprávněn uzavírat za společnost žádné smlouvy s výjimkou případů, kdy k tomu byl písemně zmocněn nebo písemně pověřen a takové pověření nebo plná moc byly adresátovi tohoto emailu případně osobě, kterou adresát zastupuje, předloženy nebo jejich existence je adresátovi či osobě jím zastoupené známá. This e-mail and any documents attached to it may be confidential and are intended only for its intended recipients. If you received this e-mail by mistake, please immediately inform its sender. Delete the contents of this e-mail with all attachments and its copies from your system. If you are not the intended recipient of this e-mail, you are not authorized to use, disseminate, copy or disclose this e-mail in any manner. The sender of this e-mail shall not be liable for any possible damage caused by modifications of the e-mail or by delay with transfer of the email. In case that this e-mail forms part of business dealings: - the sender reserves the right to end negotiations about entering
Re: [R] what constitutes a 'complete sentence'?
On 03/07/15 20:09, Federico Calboli wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? If that is your understanding you need to go back to school and learn some grammar. What you have is a noun (Functions) modified by an adjectival clause. No verb in sight. Ergo *not* a complete sentence. OTOH you are probably in good company in not knowing your grammar. The CRAN folks most likely don't know grammar either. I suspect that they *don't* actually demand a complete sentence. Such a demand would in fact be rather pedantic. Moreover I really can't see how the package checker could possibly check for complete sentences. This would require some very sophisticated programming, it seems to me. If it turns out that you *really* need a complete sentence, you could say (for instance): This package consists of functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. The foregoing *is* a complete sentence. cheers, Rolf Turner -- Technical Editor ANZJS Department of Statistics University of Auckland Phone: +64-9-373-7599 ext. 88276 __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
As I said, I found a formulation that pleased the check and that’s it for me. I am befuddled by the check in the first place though. BW F On 3 Jul 2015, at 15:14, PIKAL Petr petr.pi...@precheza.cz wrote: Hi without going deep into this matter, what if you remove / from your sentence. Cheers Petr -Original Message- From: R-help [mailto:r-help-boun...@r-project.org] On Behalf Of Hadley Wickham Sent: Friday, July 03, 2015 1:14 PM To: Federico Calboli Cc: R-help Subject: Re: [R] what constitutes a 'complete sentence'? In that case, you need to create a minimal reproducible example and make it publicly available. Hadley On Friday, July 3, 2015, Federico Calboli federico.calb...@helsinki.fi wrote: On 3 Jul 2015, at 12:14, Hadley Wickham h.wick...@gmail.com javascript:; wrote: It might be a line break problem - I think you want: Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. Tried this and unfortunately it does not help. BW F Hadley On Fri, Jul 3, 2015 at 10:09 AM, Federico Calboli federico.calb...@helsinki.fi javascript:; wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi javascript:; __ R-help@r-project.org javascript:; mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- http://had.co.nz/ -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi javascript:; -- http://had.co.nz/ [[alternative HTML version deleted]] __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting- guide.html and provide commented, minimal, self-contained, reproducible code. Tento e-mail a jakékoliv k němu připojené dokumenty jsou důvěrné a jsou určeny pouze jeho adresátům. Jestliže jste obdržel(a) tento e-mail omylem, informujte laskavě neprodleně jeho odesílatele. Obsah tohoto emailu i s přílohami a jeho kopie vymažte ze svého systému. Nejste-li zamýšleným adresátem tohoto emailu, nejste oprávněni tento email jakkoliv užívat, rozšiřovat, kopírovat či zveřejňovat. Odesílatel e-mailu neodpovídá za eventuální škodu způsobenou modifikacemi či zpožděním přenosu e-mailu. V případě, že je tento e-mail součástí obchodního jednání: - vyhrazuje si odesílatel právo ukončit kdykoliv jednání o uzavření smlouvy, a to z jakéhokoliv důvodu i bez uvedení důvodu. - a obsahuje-li nabídku, je adresát oprávněn nabídku bezodkladně přijmout; Odesílatel tohoto e-mailu (nabídky) vylučuje přijetí nabídky ze strany příjemce s dodatkem či odchylkou. - trvá odesílatel na tom, že příslušná smlouva je uzavřena teprve výslovným dosažením shody na všech jejích náležitostech. - odesílatel tohoto emailu informuje, že není oprávněn uzavírat za společnost žádné smlouvy s výjimkou případů, kdy k tomu byl písemně zmocněn nebo písemně pověřen a takové pověření nebo plná moc byly adresátovi tohoto emailu případně osobě, kterou adresát zastupuje, předloženy nebo jejich existence je adresátovi či osobě jím zastoupené známá. This e-mail and any documents attached to it may be confidential and are intended only for its intended recipients. If you received this e-mail by mistake, please immediately inform its sender. Delete the contents of this e-mail with all attachments and its copies from your system. If you are not the intended recipient of this e-mail, you are not authorized to use, disseminate, copy or disclose this e-mail in any manner. The sender of this e-mail shall not be liable for any possible damage caused by modifications of the e-mail or by delay
Re: [R] what constitutes a 'complete sentence'?
Sigh, how natural it is to say This package ..., but you probably don't know a package can be easily rejected by CRAN simply because of this phrase This package (it has been clearly stated in the R-exts manual). I don't think the grammar is the problem here. When in doubt, I always check what MASS does: http://cran.rstudio.com/web/packages/MASS/index.html Turns out its description is not a complete sentence, either. Sounds like R has become a language for statistical computing and graphics, plus English grammar since 3.0.x. Regards, Yihui -- Yihui Xie xieyi...@gmail.com Web: http://yihui.name On Fri, Jul 3, 2015 at 8:43 AM, Rolf Turner r.tur...@auckland.ac.nz wrote: On 03/07/15 20:09, Federico Calboli wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? If that is your understanding you need to go back to school and learn some grammar. What you have is a noun (Functions) modified by an adjectival clause. No verb in sight. Ergo *not* a complete sentence. OTOH you are probably in good company in not knowing your grammar. The CRAN folks most likely don't know grammar either. I suspect that they *don't* actually demand a complete sentence. Such a demand would in fact be rather pedantic. Moreover I really can't see how the package checker could possibly check for complete sentences. This would require some very sophisticated programming, it seems to me. If it turns out that you *really* need a complete sentence, you could say (for instance): This package consists of functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. The foregoing *is* a complete sentence. cheers, Rolf Turner -- Technical Editor ANZJS Department of Statistics University of Auckland Phone: +64-9-373-7599 ext. 88276 __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
On 04/07/2015 12:26 AM, Rolf Turner wrote: On 04/07/15 06:27, Yihui Xie wrote: Sigh, how natural it is to say This package ..., but you probably don't know a package can be easily rejected by CRAN simply because of this phrase This package (it has been clearly stated in the R-exts manual). Urrr! I *did* know that, but had forgotten. Apologies for my wrong-headed suggestion. Thanks for pointing out my error. I don't think the grammar is the problem here. When in doubt, I always check what MASS does: http://cran.rstudio.com/web/packages/MASS/index.html Turns out its description is not a complete sentence, either. Sounds like R has become a language for statistical computing and graphics, plus English grammar since 3.0.x. The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. There's often a difference between a requirement and the test for it. If you meet the requirement, you should pass the test, but you can often pass the test without meeting the requirement, and then you may find that the test is improved in a later version. (Requirements may also be changed, of course.) Duncan Murdoch __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
On 03-07-2015, at 14:18, Federico Calboli federico.calb...@helsinki.fi wrote: As I said, I found a formulation that pleased the check and that’s it for me. I am befuddled by the check in the first place though. And what would that formulation be (replacing the original one) ? Berend BW F On 3 Jul 2015, at 15:14, PIKAL Petr petr.pi...@precheza.cz wrote: Hi without going deep into this matter, what if you remove / from your sentence. Cheers Petr -Original Message- From: R-help [mailto:r-help-boun...@r-project.org] On Behalf Of Hadley Wickham Sent: Friday, July 03, 2015 1:14 PM To: Federico Calboli Cc: R-help Subject: Re: [R] what constitutes a 'complete sentence'? In that case, you need to create a minimal reproducible example and make it publicly available. Hadley On Friday, July 3, 2015, Federico Calboli federico.calb...@helsinki.fi wrote: On 3 Jul 2015, at 12:14, Hadley Wickham h.wick...@gmail.com javascript:; wrote: It might be a line break problem - I think you want: Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. Tried this and unfortunately it does not help. BW F Hadley On Fri, Jul 3, 2015 at 10:09 AM, Federico Calboli federico.calb...@helsinki.fi javascript:; wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi javascript:; __ R-help@r-project.org javascript:; mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- http://had.co.nz/ -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi javascript:; -- http://had.co.nz/ [[alternative HTML version deleted]] __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting- guide.html and provide commented, minimal, self-contained, reproducible code. Tento e-mail a jakékoliv k němu připojené dokumenty jsou důvěrné a jsou určeny pouze jeho adresátům. Jestliže jste obdržel(a) tento e-mail omylem, informujte laskavě neprodleně jeho odesílatele. Obsah tohoto emailu i s přílohami a jeho kopie vymažte ze svého systému. Nejste-li zamýšleným adresátem tohoto emailu, nejste oprávněni tento email jakkoliv užívat, rozšiřovat, kopírovat či zveřejňovat. Odesílatel e-mailu neodpovídá za eventuální škodu způsobenou modifikacemi či zpožděním přenosu e-mailu. V případě, že je tento e-mail součástí obchodního jednání: - vyhrazuje si odesílatel právo ukončit kdykoliv jednání o uzavření smlouvy, a to z jakéhokoliv důvodu i bez uvedení důvodu. - a obsahuje-li nabídku, je adresát oprávněn nabídku bezodkladně přijmout; Odesílatel tohoto e-mailu (nabídky) vylučuje přijetí nabídky ze strany příjemce s dodatkem či odchylkou. - trvá odesílatel na tom, že příslušná smlouva je uzavřena teprve výslovným dosažením shody na všech jejích náležitostech. - odesílatel tohoto emailu informuje, že není oprávněn uzavírat za společnost žádné smlouvy s výjimkou případů, kdy k tomu byl písemně zmocněn nebo písemně pověřen a takové pověření nebo plná moc byly adresátovi tohoto emailu případně osobě, kterou adresát zastupuje, předloženy nebo jejich existence je adresátovi či osobě jím zastoupené známá. This e-mail and any documents attached to it may be confidential and are intended only for its intended recipients. If you received this e-mail by mistake, please immediately inform its sender. Delete the contents of this e-mail with all attachments and its copies from your system. If you are not the intended recipient of this e-mail, you are not authorized to use, disseminate, copy
Re: [R] what constitutes a 'complete sentence'?
On 04/07/15 06:27, Yihui Xie wrote: Sigh, how natural it is to say This package ..., but you probably don't know a package can be easily rejected by CRAN simply because of this phrase This package (it has been clearly stated in the R-exts manual). Urrr! I *did* know that, but had forgotten. Apologies for my wrong-headed suggestion. Thanks for pointing out my error. I don't think the grammar is the problem here. When in doubt, I always check what MASS does: http://cran.rstudio.com/web/packages/MASS/index.html Turns out its description is not a complete sentence, either. Sounds like R has become a language for statistical computing and graphics, plus English grammar since 3.0.x. The CRAN guidelines should be rewritten so that they say what they *mean*. If a complete sentence is not actually required --- and it seems abundantly clear that it is not --- then guidelines should not say so. Rather they should say, clearly and comprehensibly, what actually *is* required. cheers, Rolf Turner -- Technical Editor ANZJS Department of Statistics University of Auckland Phone: +64-9-373-7599 ext. 88276 __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
[R] what constitutes a 'complete sentence'?
Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
It might be a line break problem - I think you want: Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. Hadley On Fri, Jul 3, 2015 at 10:09 AM, Federico Calboli federico.calb...@helsinki.fi wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- http://had.co.nz/ __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
Re: [R] what constitutes a 'complete sentence'?
In that case, you need to create a minimal reproducible example and make it publicly available. Hadley On Friday, July 3, 2015, Federico Calboli federico.calb...@helsinki.fi wrote: On 3 Jul 2015, at 12:14, Hadley Wickham h.wick...@gmail.com javascript:; wrote: It might be a line break problem - I think you want: Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. Tried this and unfortunately it does not help. BW F Hadley On Fri, Jul 3, 2015 at 10:09 AM, Federico Calboli federico.calb...@helsinki.fi javascript:; wrote: Hi All, I am upgrading a package for CRAN, and I get this note: checking DESCRIPTION meta-information ... NOTE Malformed Description field: should contain one or more complete sentences. This is puzzling because: cat DESCRIPTION ... Description: Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data. ... In my understanding Functions designed to test for single gene/phenotype association and for pleiotropy on genetic and genomic data.” *is* a complete sentence. So, what is complete sentence in the opinion of whomever coded that check? Best F -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi javascript:; __ R-help@r-project.org javascript:; mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code. -- http://had.co.nz/ -- Federico Calboli Ecological Genetics Research Unit Department of Biosciences PO Box 65 (Biocenter 3, Viikinkaari 1) FIN-00014 University of Helsinki Finland federico.calb...@helsinki.fi javascript:; -- http://had.co.nz/ [[alternative HTML version deleted]] __ R-help@r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
