[R-pkg-devel] (no subject)
Socorro Dominguez
@@dom|nguez @end|ng |rom ht-d@t@@com
Tue Apr 18 05:29:16 CEST 2023
Thank you all,
I really appreciate how fast you have all helped me and I am very grateful
for it.
I did not have a space. I wonder why it is rendering like that. I removed
the line and wrote it again just in case a weird character had gotten in
the way. Now I have done as you have suggested.
When I did the R CMD I had no issues locally and I had no more notes or
elements being interpreted as fields.
Thank you,
Socorro
On Mon, Apr 17, 2023 at 9:07 PM Iris Simmons <ikwsimmo using gmail.com> wrote:
> You put a space between "https:" and "//", you should definitely remove
> that. Also, you need to indent your description. Right now, your
> DESCRIPTION is being interpreted in this manner:
>
> ```
> Package
>
>
>
>
>
>
> "neotoma2"
>
>
>
>
>
>
> Title
>
>
>
>
>
> "Working with the
> Neotoma Paleoecology Database"
>
>
>
>
>
>
> Date
>
>
>
>
>
>
> "2023-04-17"
>
>
>
>
>
>
> Version
>
>
>
>
>
>
> "1.0.0"
>
>
>
>
>
>
> Authors using R
> "\n c(person(given = \"Dominguez Vidana\",\n family =
> \"Socorro\",\n role = c(\"aut\"),\n email = \"
> s.dominguez using ht-data.com\",\n comment =
> structure(\"0000-0002-7926-4935\", .Names = \"ORCID\")),\n
> person(given = \"Simon\",\n family = \"Goring\",\n
> role = c(\"aut\", \"cre\"),\n email = \"goring using wisc.edu\",\n
> comment = structure(\"0000-0002-2700-4605\", .Names =
> \"ORCID\")))"
>
>
>
>
>
>
> URL
>
>
>
>
>
> "
> https://github.com/NeotomaDB/neotoma2"
>
>
>
>
>
>
> BugReports
>
>
>
>
>
> "
> https://github.com/NeotomaDB/neotoma2/issues"
>
>
>
>
>
>
> Description
>
>
>
>
>
> "Access and manipulation of data using the
> Neotoma Paleoecology Database."
>
>
>
>
>
>
> <https
>
>
>
>
>
> "//
> api.neotomadb.org/api-docs/>."
>
>
>
>
>
>
> License
> ```
>
> You can see that it is interpreting "<https" as the name of a field and "//
> api.neotomadb.org/api-docs/>." as the contents of the field. I added 8
> spaces before "<https:" and removed the space and it worked perfectly fine.
>
> I hope this helps.
>
> On Mon, Apr 17, 2023 at 9:42 PM Socorro Dominguez <s.dominguez using ht-data.com>
> wrote:
>
>> Thank you for all the help.
>>
>> Here is the GitHub link:
>> https://github.com/NeotomaDB/neotoma2
>>
>> Best,
>>
>> Socorro
>>
>> On Mon, Apr 17, 2023 at 8:32 PM Merlise Clyde, Ph.D. <clyde using duke.edu>
>> wrote:
>>
>> > Make sure you have a period after the < > tag if that is the end of the
>> > paragraph/sentences - its is not clear it is there from the snippet that
>> > you sent.
>> > (let us know if the package is on github as then we can see the entire
>> > file)
>> >
>> > best,
>> > Merlise
>> > ------------------------------
>> > *From:* R-package-devel <r-package-devel-bounces using r-project.org> on
>> behalf
>> > of Socorro Dominguez <s.dominguez using ht-data.com>
>> > *Sent:* Monday, April 17, 2023 8:41 PM
>> > *To:* Sarah Goslee <sarah.goslee using gmail.com>
>> > *Cc:* r-package-devel using r-project.org <r-package-devel using r-project.org>
>> > *Subject:* Re: [R-pkg-devel] (no subject)
>> >
>> > Thank you!
>> >
>> > So, based on this link:
>> >
>> >
>> https://urldefense.com/v3/__https://r-pkgs.org/description.html*:*:text=to*20be*20indented*3A-,Description,-*3A*20The*20description__;I34lJSUlJSU!!OToaGQ!rL12FfD_Ox2OGl4JbHsG06nsukCSrpt3piRZQ1B5cllO12AOU7ZP2OcwA5dorRJWaIda0dk74FnqQ0xeXNINIw$
>> > <
>> >
>> https://urldefense.com/v3/__https://r-pkgs.org/description.html*:*:text=to*20be*20indented*3A-,Description,-*3A*20The*20descriptio__;I34lJSUlJSU!!OToaGQ!rL12FfD_Ox2OGl4JbHsG06nsukCSrpt3piRZQ1B5cllO12AOU7ZP2OcwA5dorRJWaIda0dk74FnqQ0wC5cqebw$
>> > >
>> > I thought I had to add indentations...
>> >
>> > So, I originally sent:
>> > ```
>> > Description: Access and manipulate data from the Neotoma Paleoecology
>> > Database. <
>> >
>> https://urldefense.com/v3/__https://api.neotomadb.org/api-docs/__;!!OToaGQ!rL12FfD_Ox2OGl4JbHsG06nsukCSrpt3piRZQ1B5cllO12AOU7ZP2OcwA5dorRJWaIda0dk74FnqQ0zYR76mxw$
>> > >
>> > ```
>> >
>> > I was requested to add <https://..> referencing the "Neotoma
>> Paleoecology
>> > Database".
>> >
>> > With the Description above, I do not get any local errors when running
>> the
>> > R CMD but can rejects it and gives me this error:
>> >
>> >
>> > If I do this:
>> > ```
>> > Description: Access and manipulate data from the Neotoma Paleoecology
>> > Database.
>> > <
>> >
>> https://urldefense.com/v3/__https://api.neotomadb.org/api-docs/__;!!OToaGQ!rL12FfD_Ox2OGl4JbHsG06nsukCSrpt3piRZQ1B5cllO12AOU7ZP2OcwA5dorRJWaIda0dk74FnqQ0zYR76mxw$
>> > >
>> > ```
>> >
>> > and run the R CMD, I get the following message:
>> > ```
>> > Unknown, possibly mis-spelled, fields in DESCRIPTION:
>> > ‘<https’
>> > ```
>> > (however, it is not an error)
>> >
>> >
>> > I see that I have to write complete sentences, so I have done the
>> > following:
>> > ```
>> > Description: Access and manipulation of data using the Neotoma
>> Paleoecology
>> > Database.
>> > <
>> >
>> https://urldefense.com/v3/__https://api.neotomadb.org/api-docs/__;!!OToaGQ!rL12FfD_Ox2OGl4JbHsG06nsukCSrpt3piRZQ1B5cllO12AOU7ZP2OcwA5dorRJWaIda0dk74FnqQ0zYR76mxw$
>> > >
>> > ```
>> >
>> > I would llike to know if this is correct prior to submitting again. Or
>> know
>> > how should I place that <https...> tag
>> >
>> > Thank you for all your help.
>> >
>> > Socorro
>> >
>> > On Mon, Apr 17, 2023 at 7:19 PM Sarah Goslee <sarah.goslee using gmail.com>
>> > wrote:
>> >
>> > > Hi,
>> > >
>> > > The Writing R Packages manual is the main documentation, specifically:
>> > >
>> >
>> https://urldefense.com/v3/__https://cran.r-project.org/doc/manuals/R-exts.html*The-DESCRIPTION-file__;Iw!!OToaGQ!rL12FfD_Ox2OGl4JbHsG06nsukCSrpt3piRZQ1B5cllO12AOU7ZP2OcwA5dorRJWaIda0dk74FnqQ0ypxASA8Q$
>> > >
>> > > As for indentation, don't. Just use a newline.
>> > >
>> > > I don't know of any templates, but the source code for many/most
>> > > packages is on RForge and/or github, so you can look at as many
>> > > DESCRIPTION files as you'd like to find the solutions you need.
>> > >
>> > > If that doesn't help, then please share actual examples of what isn't
>> > > working in your file.
>> > >
>> > > Sarah
>> > >
>> > > On Mon, Apr 17, 2023 at 8:15 PM Socorro Dominguez
>> > > <s.dominguez using ht-data.com> wrote:
>> > > >
>> > > > Hello!
>> > > >
>> > > > I need some help.
>> > > >
>> > > > Could you explain how to write the *Description* field in the
>> > > *Description*
>> > > > file when we need to add links? I don't find any rules on how to
>> write
>> > it
>> > > > when it includes links such as <https://...>
>> > > >
>> > > > Also, whenever I try to do a new line in the *Description* field
>> with
>> > the
>> > > > four spaces for indentation, I get an error from the R CMD
>> > > >
>> > > > If you could provide me with some sort of template example, I would
>> be
>> > > > extremely grateful.
>> > > >
>> > > > Best,
>> > > >
>> > > > Socorro
>> > > >
>> > > > --
>> > > > Best regards,
>> > > >
>> > > > Socorro E. Dominguez-Vidaña
>> > > > s.dominguez using ht-data.com
>> > > >
>> > > > [[alternative HTML version deleted]]
>> > > >
>> > > > ______________________________________________
>> > > > R-package-devel using r-project.org mailing list
>> > > >
>> >
>> https://urldefense.com/v3/__https://stat.ethz.ch/mailman/listinfo/r-package-devel__;!!OToaGQ!rL12FfD_Ox2OGl4JbHsG06nsukCSrpt3piRZQ1B5cllO12AOU7ZP2OcwA5dorRJWaIda0dk74FnqQ0x27JHaIA$
>> > >
>> > >
>> > >
>> > > --
>> > > Sarah Goslee (she/her)
>> > >
>> >
>> https://urldefense.com/v3/__http://www.numberwright.com__;!!OToaGQ!rL12FfD_Ox2OGl4JbHsG06nsukCSrpt3piRZQ1B5cllO12AOU7ZP2OcwA5dorRJWaIda0dk74FnqQ0x3pHxbwQ$
>> > >
>> >
>> >
>> > --
>> > Best regards,
>> >
>> > Socorro E. Dominguez-Vidaña
>> > s.dominguez using ht-data.com
>> >
>> > [[alternative HTML version deleted]]
>> >
>> > ______________________________________________
>> > R-package-devel using r-project.org mailing list
>> >
>> >
>> https://urldefense.com/v3/__https://stat.ethz.ch/mailman/listinfo/r-package-devel__;!!OToaGQ!rL12FfD_Ox2OGl4JbHsG06nsukCSrpt3piRZQ1B5cllO12AOU7ZP2OcwA5dorRJWaIda0dk74FnqQ0x27JHaIA$
>> >
>>
>>
>> --
>> Best regards,
>>
>> Socorro E. Dominguez-Vidaña
>> s.dominguez using ht-data.com
>>
>> [[alternative HTML version deleted]]
>>
>> ______________________________________________
>> R-package-devel using r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>>
>
--
Best regards,
Socorro E. Dominguez-Vidaña
s.dominguez using ht-data.com
[[alternative HTML version deleted]]
More information about the R-package-devel
mailing list