[R-pkg-devel] (no subject)

[Merlise Clyde, Ph.D.]

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$

	[[alternative HTML version deleted]]